Minor documentation updates
This commit is contained in:
@@ -37,6 +37,4 @@ domains/
|
|||||||
config/
|
config/
|
||||||
key: []byte(...)
|
key: []byte(...)
|
||||||
cert: []byte(...)
|
cert: []byte(...)
|
||||||
|
|
||||||
|
|
||||||
```
|
```
|
||||||
|
27
README.md
27
README.md
@@ -87,23 +87,34 @@ purpose system.
|
|||||||
### Initialize a new database
|
### 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
|
You can also provide the postmaster password in an environment variable:
|
||||||
account, or you can provide on the command line: `-adminPassword x`, or in an
|
|
||||||
environment variable: `CROCKERY_PASSWORD=x`.
|
|
||||||
|
|
||||||
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
|
### Run the server
|
||||||
|
|
||||||
```
|
```
|
||||||
./crockery
|
./crockery run
|
||||||
```
|
```
|
||||||
|
|
||||||
Again, you can use `-db <filename>` if the default of `./crockery.db` doesn't
|
Again, you can use `--db <filename>` if the default of `./crockery.db` doesn't
|
||||||
suit.
|
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
|
### Configuration
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user