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