docs: create a readthedocs manual

The goal is to remove the WIKI since modifications can not be
submitted via PRs.
This commit is contained in:
Antoine Eiche 2020-07-02 21:02:47 +02:00 committed by lewo
parent eb70dd1f55
commit 781073b64d
8 changed files with 471 additions and 6 deletions

39
docs/howto-develop.rst Normal file
View file

@ -0,0 +1,39 @@
How to Develop SNM
==================
Run tests
---------
You can run the testsuite via
::
nix-build tests -A extern.nixpkgs_20_03
nix-build tests -A intern.nixpkgs_unstable
...
Nixops
------
You can test the setup via ``nixops``. After installation, do
::
nixops create nixops/single-server.nix nixops/vbox.nix -d mail
nixops deploy -d mail
nixops info -d mail
You can then test the server via e.g. \ ``telnet``. To log into it, use
::
nixops ssh -d mail mailserver
Imap
----
To test imap manually use
::
openssl s_client -host mail.example.com -port 143 -starttls imap