From 7e84fd4c937ae7d40b19e715492fcc5ec577d6c7 Mon Sep 17 00:00:00 2001 From: Antoine Eiche Date: Fri, 29 Jan 2021 10:21:25 +0100 Subject: [PATCH] doc: add a section howto This section contains advanced configuration howtos. --- docs/{howto-add-radicale.rst => add-radicale.rst} | 4 ++-- docs/backup-guide.rst | 10 +++++----- docs/howto-develop.rst | 4 ++-- docs/index.rst | 12 +++++++++--- docs/rspamd-tuning.rst | 4 ++-- docs/setup-guide.rst | 4 ++-- 6 files changed, 22 insertions(+), 16 deletions(-) rename docs/{howto-add-radicale.rst => add-radicale.rst} (96%) diff --git a/docs/howto-add-radicale.rst b/docs/add-radicale.rst similarity index 96% rename from docs/howto-add-radicale.rst rename to 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,11 +16,17 @@ Welcome to NixOS Mailserver's documentation! quick-start setup-guide howto-develop - backup-guide - howto-add-radicale - rspamd-tuning release-notes +.. toctree:: + :maxdepth: 1 + :caption: How-to + + backup-guide + add-radicale + rspamd-tuning + + 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 `_ 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