summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorjvoisin2017-10-10 11:24:58 +0200
committerGitHub2017-10-10 11:24:58 +0200
commitc943df064e29d6710eb8f1c70acda0fd0c1dfbeb (patch)
tree39b25c73eedf9d44eb7aa65c7843e968b456dd4e /doc
parent1602780f3c85ca127c77d28ae93a4e2a4eeae180 (diff)
Fix a few typos in the documentation
Courtesy of @watw00t
Diffstat (limited to 'doc')
-rw-r--r--doc/source/faq.rst16
1 files changed, 8 insertions, 8 deletions
diff --git a/doc/source/faq.rst b/doc/source/faq.rst
index 71326b6..d76a045 100644
--- a/doc/source/faq.rst
+++ b/doc/source/faq.rst
@@ -45,7 +45,7 @@ with a strong focus on security. We do have hardening
45(`kernel <https://grsecurity.net/>`_, `WAF <https://naxsi.org>`_, 45(`kernel <https://grsecurity.net/>`_, `WAF <https://naxsi.org>`_,
46`IDS <https://en.wikipedia.org/wiki/Intrusion_detection_system>`_, etc) 46`IDS <https://en.wikipedia.org/wiki/Intrusion_detection_system>`_, etc)
47below the web stack, but most of the time, when a website is compromised, 47below the web stack, but most of the time, when a website is compromised,
48it's can be to send ads, spam, deface it, steal data etc. 48it can be to send ads, spam, deface it, steal data etc.
49This is why we need to harden the website itself too, but we can't touch its 49This is why we need to harden the website itself too, but we can't touch its
50source code. 50source code.
51 51
@@ -60,7 +60,7 @@ We're huge fans of `Suhosin <https://suhosin.org>`_, unfortunately:
60- it has some shortcomings by design 60- it has some shortcomings by design
61 61
62We're using the `disable_function <https://secure.php.net/manual/en/ini.core.php#ini.disable-functions>`_ 62We're using the `disable_function <https://secure.php.net/manual/en/ini.core.php#ini.disable-functions>`_
63directive, but unfortunately, it doesn't provide enough usable granularity (guess how many CMS are using 63directive, but unfortunately, it doesn't provide enough usable granularity (guess how many CMSs are using
64the `system <https://secure.php.net/manual/en/function.system.php#refsect1-function.system-notes>`_ 64the `system <https://secure.php.net/manual/en/function.system.php#refsect1-function.system-notes>`_
65function to perform various mandatory maintenance tasks). 65function to perform various mandatory maintenance tasks).
66 66
@@ -92,7 +92,7 @@ it becomes compromised.
92How mature is this project? 92How mature is this project?
93""""""""""""""""""""""""""" 93"""""""""""""""""""""""""""
94 94
95This project was floating around since early 2016 and we did the first commit 95This project has been floating around since early 2016 and we did the first commit
96the 28ᵗʰ of December of the same year. We're currently in an alpha phase, 96the 28ᵗʰ of December of the same year. We're currently in an alpha phase,
97finding and fixing as many bugs as possible before the beta. 97finding and fixing as many bugs as possible before the beta.
98 98
@@ -113,13 +113,13 @@ is still a security issue, and should be treated as such.
113We don't have the pretention to state that Snuffleupagus will magically solve 113We don't have the pretention to state that Snuffleupagus will magically solve
114all your security issues, but we believe that it might definitely help. 114all your security issues, but we believe that it might definitely help.
115 115
116Why should you send us bugs, security issues and patches? 116Why should I send you bugs, security issues and patches?
117""""""""""""""""""""""""""""""""""""""""""""""""""""""""" 117"""""""""""""""""""""""""""""""""""""""""""""""""""""""""
118Snuffleupagus is an open-source security software, by reporting (or fixing) 118Snuffleupagus is an open-source security software, by reporting (or fixing)
119bugs, or implementing new features, you are helping others to protect themselves. 119bugs, or implementing new features, you are helping others to protect themselves.
120 120
121We're also firm believer in the *Beerbounty* system: 121We're also firm believers in the *Beerbounty* system:
122we are happy to offer you beers when/if we ever met if you helped the project in 122we are happy to offer you beers when/if we ever meet if you helped the project in
123any way. If you don't like beer, we're sure that we'll find something else, 123any way. If you don't like beer, we're sure that we'll find something else,
124don't worry. 124don't worry.
125 125
@@ -135,7 +135,7 @@ Some options won't break anything, like :ref:`harden-rand <harden-rand-feature>`
135but some like :ref:`global_strict <global-strict-feature>` 135but some like :ref:`global_strict <global-strict-feature>`
136or overly-restrictive :ref:`virtual-patching<virtual-patching-feature>` 136or overly-restrictive :ref:`virtual-patching<virtual-patching-feature>`
137rules might pretty well break your website. 137rules might pretty well break your website.
138It's up to you to configure Snuffleupaggus accordingly to your needs. 138It's up to you to configure Snuffleupagus accordingly to your needs.
139 139
140You can also enable the ``simulation`` mode on features that you're not sure about, 140You can also enable the ``simulation`` mode on features that you're not sure about,
141to see what snuffleupagus would do to your application, before activating them for good. 141to see what snuffleupagus would do to your application, before activating them for good.
@@ -222,7 +222,7 @@ I found a bug. How can I report it?
222""""""""""""""""""""""""""""""""""" 222"""""""""""""""""""""""""""""""""""
223We do have an issue tracker on `Github <https://github.com/nbs-system/snuffleupagus/issues>`_. 223We do have an issue tracker on `Github <https://github.com/nbs-system/snuffleupagus/issues>`_.
224Please make sure to include as much information as possible when reporting your issue, 224Please make sure to include as much information as possible when reporting your issue,
225such as your operating system, your version of PHP 7, your version of snuffleupagus, 225such as your operating system, your version of PHP 7, your version of Snuffleupagus,
226your logs, the problematic php code, the request, a brief description, … long story short, 226your logs, the problematic php code, the request, a brief description, … long story short,
227give us everything that you can. 227give us everything that you can.
228 228