diff options
author | Niall Sheridan <nsheridan@gmail.com> | 2017-01-09 10:07:56 +0000 |
---|---|---|
committer | GitHub <noreply@github.com> | 2017-01-09 10:07:56 +0000 |
commit | fc190076448ebf1710910a89b584857cbc89d159 (patch) | |
tree | b82061b8a2af25fbc13f6f9792d42ed7a2ed9d54 /README.md | |
parent | a4b5776500b1250b61c3dafd17e464fdf3f3aae8 (diff) | |
parent | 6dfe350cb5eefde3a99374d14c083d1906717ddd (diff) |
Merge branch 'master' into opts2
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 9 |
1 files changed, 5 insertions, 4 deletions
@@ -100,11 +100,11 @@ For any option that takes a file path as a parameter (e.g. SSH signing key, TLS - A [Vault](https://www.vaultproject.io) path + key starting with `/vault/` e.g. `/vault/secret/cashier/ssh_signing_key`. You should add a [vault](#vault) config as needed. ## server -- `use_tls` : boolean. If this is set then `tls_key` and `tls_cert` are required. +- `use_tls` : boolean. If this is set then either `tls_key` and `tls_cert` are required, or `letsencrypt_servername` is required. - `tls_key` : string. Path to the TLS key. See the [note](#a-note-on-files) on files above. - `tls_cert` : string. Path to the TLS cert. See the [note](#a-note-on-files) on files above. - `letsencrypt_servername`: string. If set will request a certificate from LetsEncrypt. This should match the expected FQDN of the server. -- `letsencrypt_cachedir: string. Directory to cache the LetsEncrypt certificate. +- `letsencrypt_cachedir`: string. Directory to cache the LetsEncrypt certificate. - `address` : string. IP address to listen on. If unset the server listens on all addresses. - `port` : int. Port to listen on. - `user` : string. User to which the server drops privileges to. @@ -151,8 +151,9 @@ server { } ``` -Prior to using MySQL, MongoDB or SQLite you need to create the database and tables using the [dbinit tool](cmd/dbinit/dbinit.go). -dbinit hasn't been tested with mongo replica sets. +Prior to using MySQL, MongoDB or SQLite you need to create the database and tables using [one of the provided files](db). +e.g. `mysql < db/seed.sql` or `mongo db/seed.js`. +Obviously you should setup a role user for running in prodution. ### datastore |