diff options
| author | Antoine Eiche <lewo@abesis.fr> | 2021-01-29 10:21:25 +0100 |
|---|---|---|
| committer | lewo <lewo@abesis.fr> | 2021-03-03 08:36:08 +0000 |
| commit | 7e84fd4c937ae7d40b19e715492fcc5ec577d6c7 (patch) | |
| tree | 36f6bc956b2683b292dff0ee76e46c57c03cda0b /docs | |
| parent | 0c4b9a898527dcaf9a3491ad1cb37a6c3a7b1b63 (diff) | |
doc: add a section howto
This section contains advanced configuration howtos.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/add-radicale.rst (renamed from docs/howto-add-radicale.rst) | 4 | ||||
| -rw-r--r-- | docs/backup-guide.rst | 10 | ||||
| -rw-r--r-- | docs/howto-develop.rst | 4 | ||||
| -rw-r--r-- | docs/index.rst | 10 | ||||
| -rw-r--r-- | docs/rspamd-tuning.rst | 4 | ||||
| -rw-r--r-- | docs/setup-guide.rst | 4 |
6 files changed, 21 insertions, 15 deletions
diff --git a/docs/howto-add-radicale.rst b/docs/add-radicale.rst index ea01d5b..3f29434 100644 --- a/docs/howto-add-radicale.rst +++ b/docs/add-radicale.rst @@ -1,5 +1,5 @@ -How to Add Radicale to SNM -========================== +Add Radicale +============ Configuration by @dotlambda diff --git a/docs/backup-guide.rst b/docs/backup-guide.rst index 57acc2a..ef7a848 100644 --- a/docs/backup-guide.rst +++ b/docs/backup-guide.rst @@ -1,9 +1,9 @@ -A Complete Backup Guide -======================= +Backup Guide +============ -This is really easy. First off you should have a backup of your -``configuration.nix`` file where you have the server config (but that is -already in a git repository right?) +First off you should have a backup of your ``configuration.nix`` file +where you have the server config (but that is already in a git +repository right?) Next you need to backup ``/var/vmail`` or whatever you have specified for the option ``mailDirectory``. This is where all the mails reside. diff --git a/docs/howto-develop.rst b/docs/howto-develop.rst index 173c4f3..cb7ece1 100644 --- a/docs/howto-develop.rst +++ b/docs/howto-develop.rst @@ -1,5 +1,5 @@ -How to Develop SNM -================== +Contribute or troubleshoot +========================== Run NixOS tests --------------- diff --git a/docs/index.rst b/docs/index.rst index d30d56c..4961f21 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -16,10 +16,16 @@ Welcome to NixOS Mailserver's documentation! quick-start setup-guide howto-develop + release-notes + +.. toctree:: + :maxdepth: 1 + :caption: How-to + backup-guide - howto-add-radicale + add-radicale rspamd-tuning - release-notes + Indices and tables ================== diff --git a/docs/rspamd-tuning.rst b/docs/rspamd-tuning.rst index a119a34..46886f2 100644 --- a/docs/rspamd-tuning.rst +++ b/docs/rspamd-tuning.rst @@ -1,5 +1,5 @@ -How to tune spam filtering -========================== +Tune spam filtering +=================== SNM comes with the `rspamd spam filtering system <https://rspamd.com/>`_ enabled by default. Although its out-of-the-box performance is good, you diff --git a/docs/setup-guide.rst b/docs/setup-guide.rst index cc53283..e582e90 100644 --- a/docs/setup-guide.rst +++ b/docs/setup-guide.rst @@ -1,5 +1,5 @@ -A Complete Setup Guide -====================== +Setup Guide +=========== Mail servers can be a tricky thing to set up. This guide is supposed to run you through the most important steps to achieve a 10/10 score on |