Skip to content

Created and modififed Markdown version of README.TXT #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

Created and modififed Markdown version of README.TXT #16

wants to merge 2 commits into from

Conversation

sroberts
Copy link

Love the project and just wanted to help out a bit. I created a Markdown version of the README, which tends to display a little better, and rearranged some of the content to flow a little better, I believe without changing any meaning.

Hope this helps, you guys rock! 👍

SR

@brenosilva
Copy link
Contributor

Hello Scott,

Thank you for your submission.
I wouldn't like to create a new file with the same content. Maybe you can re-format the README.txt ?

@sroberts
Copy link
Author

Breno,

Happy to help. Unfortunately if you want the MarkDown format to appear on GitHub it's necessary to change the file extension to .md.

You can see an example here: https://github.com/sroberts/test

That said I agree there's no need for redundant READMEs. I would suggest adding a Deleting the README.txt as a part of this commit and just using README.md as the main README file.

@brenosilva
Copy link
Contributor

Scott,

We really don't know if we will stay in github. They are disabling some features :/
So i don't want to apply a patch that could be useful only for this framework... and in the future need to revert it.

If you want to change the .txt to show its content better... let me know.

Thanks

@brenosilva brenosilva closed this Jan 1, 2013
@sroberts
Copy link
Author

sroberts commented Jan 2, 2013

Breno,

That's really too bad. As it happens I work with GitHub and I'd be happy to talk with you about your concerns. Feel free to shoot me a message or email. Either way thanks for the response and great project.

SR

zimmerle pushed a commit that referenced this pull request Apr 30, 2014
Add a check for the definition MOVE_REQUEST_CHAIN_TO_MODSEC, whenever it is
set the chain will be moved into the brigade. If it was not set the chain
will be only copied. Moving was causing segfaults on the following
regression tests:

 #15 - SecRequestBodyInMemoryLimit
 #16 - SecRequestBodyInMemoryLimit (greater)
 #19 - SecRequestBodyLimitAction ProcessPartial (multipart/greater - chunked)
 (from: regression/config/10-request-directives.t)
zimmerle pushed a commit that referenced this pull request Jul 30, 2014
Add a check for the definition MOVE_REQUEST_CHAIN_TO_MODSEC, whenever it is
set the chain will be moved into the brigade. If it was not set the chain
will be only copied. Moving was causing segfaults on the following
regression tests:

 #15 - SecRequestBodyInMemoryLimit
 #16 - SecRequestBodyInMemoryLimit (greater)
 #19 - SecRequestBodyLimitAction ProcessPartial (multipart/greater - chunked)
 (from: regression/config/10-request-directives.t)
zimmerle pushed a commit that referenced this pull request Dec 4, 2014
Add a check for the definition MOVE_REQUEST_CHAIN_TO_MODSEC, whenever it is
set the chain will be moved into the brigade. If it was not set the chain
will be only copied. Moving was causing segfaults on the following
regression tests:

 #15 - SecRequestBodyInMemoryLimit
 #16 - SecRequestBodyInMemoryLimit (greater)
 #19 - SecRequestBodyLimitAction ProcessPartial (multipart/greater - chunked)
 (from: regression/config/10-request-directives.t)
zimmerle pushed a commit that referenced this pull request Jan 9, 2015
Add a check for the definition MOVE_REQUEST_CHAIN_TO_MODSEC, whenever it is
set the chain will be moved into the brigade. If it was not set the chain
will be only copied. Moving was causing segfaults on the following
regression tests:

 #15 - SecRequestBodyInMemoryLimit
 #16 - SecRequestBodyInMemoryLimit (greater)
 #19 - SecRequestBodyLimitAction ProcessPartial (multipart/greater - chunked)
 (from: regression/config/10-request-directives.t)
zimmerle pushed a commit that referenced this pull request Jan 12, 2015
Add a check for the definition MOVE_REQUEST_CHAIN_TO_MODSEC, whenever it is
set the chain will be moved into the brigade. If it was not set the chain
will be only copied. Moving was causing segfaults on the following
regression tests:

 #15 - SecRequestBodyInMemoryLimit
 #16 - SecRequestBodyInMemoryLimit (greater)
 #19 - SecRequestBodyLimitAction ProcessPartial (multipart/greater - chunked)
 (from: regression/config/10-request-directives.t)
zimmerle pushed a commit that referenced this pull request Mar 24, 2015
Add a check for the definition MOVE_REQUEST_CHAIN_TO_MODSEC, whenever it is
set the chain will be moved into the brigade. If it was not set the chain
will be only copied. Moving was causing segfaults on the following
regression tests:

 #15 - SecRequestBodyInMemoryLimit
 #16 - SecRequestBodyInMemoryLimit (greater)
 #19 - SecRequestBodyLimitAction ProcessPartial (multipart/greater - chunked)
 (from: regression/config/10-request-directives.t)
@pbesedm pbesedm mentioned this pull request May 8, 2015
zimmerle pushed a commit that referenced this pull request Jun 30, 2015
Add a check for the definition MOVE_REQUEST_CHAIN_TO_MODSEC, whenever it is
set the chain will be moved into the brigade. If it was not set the chain
will be only copied. Moving was causing segfaults on the following
regression tests:

 #15 - SecRequestBodyInMemoryLimit
 #16 - SecRequestBodyInMemoryLimit (greater)
 #19 - SecRequestBodyLimitAction ProcessPartial (multipart/greater - chunked)
 (from: regression/config/10-request-directives.t)
zimmerle pushed a commit that referenced this pull request Feb 1, 2016
Add a check for the definition MOVE_REQUEST_CHAIN_TO_MODSEC, whenever it is
set the chain will be moved into the brigade. If it was not set the chain
will be only copied. Moving was causing segfaults on the following
regression tests:

 #15 - SecRequestBodyInMemoryLimit
 #16 - SecRequestBodyInMemoryLimit (greater)
 #19 - SecRequestBodyLimitAction ProcessPartial (multipart/greater - chunked)
 (from: regression/config/10-request-directives.t)
zimmerle pushed a commit that referenced this pull request Feb 1, 2016
Add a check for the definition MOVE_REQUEST_CHAIN_TO_MODSEC, whenever it is
set the chain will be moved into the brigade. If it was not set the chain
will be only copied. Moving was causing segfaults on the following
regression tests:

 #15 - SecRequestBodyInMemoryLimit
 #16 - SecRequestBodyInMemoryLimit (greater)
 #19 - SecRequestBodyLimitAction ProcessPartial (multipart/greater - chunked)
 (from: regression/config/10-request-directives.t)
zimmerle pushed a commit that referenced this pull request Feb 2, 2016
Add a check for the definition MOVE_REQUEST_CHAIN_TO_MODSEC, whenever it is
set the chain will be moved into the brigade. If it was not set the chain
will be only copied. Moving was causing segfaults on the following
regression tests:

 #15 - SecRequestBodyInMemoryLimit
 #16 - SecRequestBodyInMemoryLimit (greater)
 #19 - SecRequestBodyLimitAction ProcessPartial (multipart/greater - chunked)
 (from: regression/config/10-request-directives.t)
zimmerle pushed a commit that referenced this pull request Feb 2, 2016
Add a check for the definition MOVE_REQUEST_CHAIN_TO_MODSEC, whenever it is
set the chain will be moved into the brigade. If it was not set the chain
will be only copied. Moving was causing segfaults on the following
regression tests:

 #15 - SecRequestBodyInMemoryLimit
 #16 - SecRequestBodyInMemoryLimit (greater)
 #19 - SecRequestBodyLimitAction ProcessPartial (multipart/greater - chunked)
 (from: regression/config/10-request-directives.t)
zimmerle pushed a commit that referenced this pull request Feb 2, 2016
Add a check for the definition MOVE_REQUEST_CHAIN_TO_MODSEC, whenever it is
set the chain will be moved into the brigade. If it was not set the chain
will be only copied. Moving was causing segfaults on the following
regression tests:

 #15 - SecRequestBodyInMemoryLimit
 #16 - SecRequestBodyInMemoryLimit (greater)
 #19 - SecRequestBodyLimitAction ProcessPartial (multipart/greater - chunked)
 (from: regression/config/10-request-directives.t)
daniilyar pushed a commit to daniilyar/ModSecurity that referenced this pull request Feb 5, 2016
Refactoring on the nginx module, including:
 - Better handling larger posts;
 - Now using nginx echo module during the regression tests.
 - Better interacting with neginx chain rules
 - Separation of the request handling and content filters.
 - Better handling nginx sessions and resource counts to allow a
   more efficient garbage collector.
 - Handling both http/1.0 and 1.1, including keep-alive.
 - Tests are now capable to test nginx as a proxy or end-server.
 - Tested agains nginx 1.6 and 1.7.
 - better dealing with chunked request body
 - Refactoring: split lines longer than 80 characters, remove trailing whitespaces, change CRLF to LF
 - Copy the req body chain to be processed instead of move:

Add a check for the definition MOVE_REQUEST_CHAIN_TO_MODSEC, whenever it is
set the chain will be moved into the brigade. If it was not set the chain
will be only copied. Moving was causing segfaults on the following
regression tests:

 owasp-modsecurity#15 - SecRequestBodyInMemoryLimit
 owasp-modsecurity#16 - SecRequestBodyInMemoryLimit (greater)
 owasp-modsecurity#19 - SecRequestBodyLimitAction ProcessPartial (multipart/greater - chunked)
 (from: regression/config/10-request-directives.t)
daniilyar pushed a commit to daniilyar/ModSecurity that referenced this pull request Feb 5, 2016
Add a check for the definition MOVE_REQUEST_CHAIN_TO_MODSEC, whenever it is
set the chain will be moved into the brigade. If it was not set the chain
will be only copied. Moving was causing segfaults on the following
regression tests:

 owasp-modsecurity#15 - SecRequestBodyInMemoryLimit
 owasp-modsecurity#16 - SecRequestBodyInMemoryLimit (greater)
 owasp-modsecurity#19 - SecRequestBodyLimitAction ProcessPartial (multipart/greater - chunked)
 (from: regression/config/10-request-directives.t)
@pbesedm pbesedm mentioned this pull request Mar 12, 2016
chewi pushed a commit to yakara-ltd/ModSecurity that referenced this pull request May 2, 2016
Add a check for the definition MOVE_REQUEST_CHAIN_TO_MODSEC, whenever it is
set the chain will be moved into the brigade. If it was not set the chain
will be only copied. Moving was causing segfaults on the following
regression tests:

 owasp-modsecurity#15 - SecRequestBodyInMemoryLimit
 owasp-modsecurity#16 - SecRequestBodyInMemoryLimit (greater)
 owasp-modsecurity#19 - SecRequestBodyLimitAction ProcessPartial (multipart/greater - chunked)
 (from: regression/config/10-request-directives.t)
chewi pushed a commit to yakara-ltd/ModSecurity that referenced this pull request May 2, 2016
Add a check for the definition MOVE_REQUEST_CHAIN_TO_MODSEC, whenever it is
set the chain will be moved into the brigade. If it was not set the chain
will be only copied. Moving was causing segfaults on the following
regression tests:

 owasp-modsecurity#15 - SecRequestBodyInMemoryLimit
 owasp-modsecurity#16 - SecRequestBodyInMemoryLimit (greater)
 owasp-modsecurity#19 - SecRequestBodyLimitAction ProcessPartial (multipart/greater - chunked)
 (from: regression/config/10-request-directives.t)
@wergoth wergoth mentioned this pull request Jul 25, 2017
@hsluoyz
Copy link

hsluoyz commented Jul 25, 2018

@brenosilva @sroberts , I'm new to this project and I want to learn it. But the first thing I encountered is that the format of the README hurts my eyes :(

I had a read about this thread. It has been 5 years and we are still at GitHub. Moreover, Markdown is a neutral and defacto dominating standard for open-source intro pages. It is not only useful in GitHub but also other places. Even if one day we leave GitHub, we still can utilize the Markdown documents. So I think we should delete TXTs and use Markdown instead. What do you think?

@victorhora
Copy link
Contributor

@hsluoyz we are already using a Markdown with the README in the newest version of ModSecurity, libModSecurity (aka v3.0):

https://github.com/SpiderLabs/ModSecurity/blob/v3/master/README.md

@hsluoyz
Copy link

hsluoyz commented Jul 28, 2018

Hi @victorhora , my team still believes that ModSecurity 3.0 is not mature enough, there are still many bugs and the performance cannot reach 2.x for now. Moreover, ModSecurity 3.0 is not available on Windows but I'm a Windows user :(

So I think it's still meaningful to port 2.x's README to Markdown. What do you think?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants