From a76596c3485901602091b335c5712fa2a05feccd Mon Sep 17 00:00:00 2001 From: teru Date: Wed, 17 Aug 2016 22:08:54 +0900 Subject: [PATCH 1/2] Add migration guide from directorz/mailfull #9 --- doc/migrating_from_mailfull.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 doc/migrating_from_mailfull.md diff --git a/doc/migrating_from_mailfull.md b/doc/migrating_from_mailfull.md new file mode 100644 index 0000000..20234e6 --- /dev/null +++ b/doc/migrating_from_mailfull.md @@ -0,0 +1,24 @@ +Migrating from mailfull +======================= + +Migrating from [directorz/mailfull](https://github.com/directorz/mailfull) + +Change directory to Mailfull directory. + +``` +# su - mailfull +$ cd /home/mailfull +``` + +Initialize a directory as a Mailfull repository. + +``` +$ mailfull init +``` + +Delete unnecessary files. + +``` +$ rm -rf .git .gitignore bin docs lib README.md README.ja.md +$ find domains -maxdepth 2 -name '.vforward' | xargs rm -f +``` From ab3c3315f990a382d30892ae03de9b74b353480f Mon Sep 17 00:00:00 2001 From: teru Date: Wed, 17 Aug 2016 22:15:47 +0900 Subject: [PATCH 2/2] 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 |