Minor documentation updates

This commit is contained in:
2018-03-05 23:37:13 +00:00
parent 3ad8c6f59f
commit 6ac949e395
2 changed files with 19 additions and 10 deletions

View File

@@ -37,6 +37,4 @@ domains/
config/
key: []byte(...)
cert: []byte(...)
```

View File

@@ -87,23 +87,34 @@ purpose system.
### Initialize a new database
```
crockery init -domain example.com
crockery init \
--domain <domain-name> \
--cert <cert-file> \
--key <key-file> \
--postmaster-password <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 <filename>`
```
CROCKERY_POSTMASTER_PASSWORD="<password>" crockery init --domain <domain-name> ---cert <cert-file> --key <key-file>
```
You can provide a custom database name with `--db <filename>`:
```
crockery --db foo.db init --domain <domain-name> ---cert <cert-file> --key <key-file>
```
### Run the server
```
./crockery
./crockery run
```
Again, you can use `-db <filename>` if the default of `./crockery.db` doesn't
suit.
Again, you can use `--db <filename>` 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