From 6ac949e3958900362f1cfe027bbba5ac5bec1dac Mon Sep 17 00:00:00 2001 From: Nick Thomas Date: Mon, 5 Mar 2018 23:37:13 +0000 Subject: [PATCH] Minor documentation updates --- DESIGN.md | 2 -- README.md | 27 +++++++++++++++++++-------- 2 files changed, 19 insertions(+), 10 deletions(-) diff --git a/DESIGN.md b/DESIGN.md index df95f90..4a5d517 100644 --- a/DESIGN.md +++ b/DESIGN.md @@ -37,6 +37,4 @@ domains/ config/ key: []byte(...) cert: []byte(...) - - ``` diff --git a/README.md b/README.md index 1dea559..bef0784 100644 --- a/README.md +++ b/README.md @@ -87,23 +87,34 @@ purpose system. ### Initialize a new database ``` -crockery init -domain example.com +crockery init \ + --domain \ + --cert \ + --key \ + --postmaster-password ``` -You'll be prompted to enter a password for the `postmaster@example.com` master -account, or you can provide on the command line: `-adminPassword x`, or in an -environment variable: `CROCKERY_PASSWORD=x`. +You can also provide the postmaster password in an environment variable: -You can provide a custom database name with `-db ` +``` +CROCKERY_POSTMASTER_PASSWORD="" crockery init --domain ---cert --key +``` + +You can provide a custom database name with `--db `: + +``` +crockery --db foo.db init --domain ---cert --key +``` ### Run the server ``` -./crockery +./crockery run ``` -Again, you can use `-db ` if the default of `./crockery.db` doesn't -suit. +Again, you can use `--db ` if the default of `./crockery.db` doesn't +suit. Crockery will load the configuration from the database and begin serving +mail based on it. Received emails are also stored in the same file. ### Configuration