From ab3c3315f990a382d30892ae03de9b74b353480f Mon Sep 17 00:00:00 2001 From: teru Date: Wed, 17 Aug 2016 22:15:47 +0900 Subject: [PATCH] Add configuration guide --- README.md | 5 +++++ doc/README.md | 5 +++++ doc/configuration.md | 12 ++++++++++++ 3 files changed, 22 insertions(+) create mode 100644 doc/README.md create mode 100644 doc/configuration.md diff --git a/README.md b/README.md index 747d1a3..55d0832 100644 --- a/README.md +++ b/README.md @@ -66,3 +66,8 @@ Add a new domain and user. ``` Enjoy! + +More info +--------- + +See [documentation](doc/README.md) diff --git a/doc/README.md b/doc/README.md new file mode 100644 index 0000000..e427e21 --- /dev/null +++ b/doc/README.md @@ -0,0 +1,5 @@ +Documentation +============= + +- [Configuration](configuration.md) +- [Migrating from mailfull](migrating_from_mailfull.md) diff --git a/doc/configuration.md b/doc/configuration.md new file mode 100644 index 0000000..aa73a0d --- /dev/null +++ b/doc/configuration.md @@ -0,0 +1,12 @@ +Configuration +============= + +`.mailfull/config` + +| key | type | default | required | description | +|:----|:-----|:--------|:---------|:------------| +| dir_database | string | `"./etc"` | no | A relative path from repository dir (or a absolute path) | +| dir_maildata | string | `"./domains"` | no | A relative path from repository dir (or a absolute path) | +| username | string | The username who executed `mailfull init` | **yes** | It used for setting owner of database files and maildata files. | +| cmd_postalias | string | `"postalias"` | no | Command name or path | +| cmd_postmap | string | `"postmap"` | no | Command name or path |