Skip to content

Commit

Permalink
docs: improve documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Aeneas Rekkas (arekkas) committed May 6, 2017
1 parent 19339e3 commit 932f409
Show file tree
Hide file tree
Showing 4 changed files with 3 additions and 32 deletions.
18 changes: 3 additions & 15 deletions cmd/host.go
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,9 @@ CORE CONTROLS
=============
- DATABASE_URL: A URL to a persistent backend. Hydra supports various backends:
- None: If DATABASE_URL is empty, all data will be lost when the command is killed.
- Memory: If DATABASE_URL is "memory", data will be written to memory and is lost when you restart this instance.
Example: DATABASE_URL=memory
- Postgres: If DATABASE_URL is a DSN starting with postgres:// PostgreSQL will be used as storage backend.
Example: DATABASE_URL=postgres://user:password@host:123/database
Expand All @@ -34,19 +36,6 @@ CORE CONTROLS
Be aware that the ?parseTime=true parameter is mandatory, or timestamps will not work.
- RethinkDB: If DATABASE_URL is a DSN starting with rethinkdb:// RethinkDB will be used as storage backend.
Example: DATABASE_URL=rethinkdb://user:password@host:123/database
Additionally, these controls are available when using RethinkDB:
- RETHINK_TLS_CERT_PATH: The path to the TLS certificate (pem encoded) used to connect to rethinkdb.
Example: RETHINK_TLS_CERT_PATH=~/rethink.pem
- RETHINK_TLS_CERT: A pem encoded TLS certificate passed as string. Can be used instead of RETHINK_TLS_CERT_PATH.
Example: RETHINK_TLS_CERT_PATH="-----BEGIN CERTIFICATE-----\nMIIDZTCCAk2gAwIBAgIEV5xOtDANBgkqhkiG9w0BAQ0FADA0MTIwMAYDVQQDDClP..."
- Redis: If DATABASE_URL is a DNS starting with redis:// Redis will be used as a storage backend.
Example: DATABASE_URL=redis://x:password@host:6379/0
- SYSTEM_SECRET: A secret that is at least 16 characters long. If none is provided, one will be generated. They key
is used to encrypt sensitive data using AES-GCM (256 bit) and validate HMAC signatures.
Example: SYSTEM_SECRET=jf89-jgklAS9gk3rkAF90dfsk
Expand Down Expand Up @@ -146,5 +135,4 @@ func init() {
hostCmd.Flags().Bool("dangerous-auto-logon", false, "Stores the root credentials in ~/.hydra.yml. Do not use in production.")
hostCmd.Flags().String("https-tls-key-path", "", "Path to the key file for HTTP/2 over TLS (https). You can set HTTPS_TLS_KEY_PATH or HTTPS_TLS_KEY instead.")
hostCmd.Flags().String("https-tls-cert-path", "", "Path to the certificate file for HTTP/2 over TLS (https). You can set HTTPS_TLS_CERT_PATH or HTTPS_TLS_CERT instead.")
hostCmd.Flags().String("rethink-tls-cert-path", "", "Path to the certificate file to connect to rethinkdb over TLS (https). You can set RETHINK_TLS_CERT_PATH or RETHINK_TLS_CERT instead.")
}
1 change: 0 additions & 1 deletion docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,5 @@
* [Should I use OAuth2 tokens for authentication?](faq/oauth2-auth.md)
* [What will happen if an error occurs during an OAuth2 flow?](faq/oauth2-error.md)
* [Why isn't the redirect url working?](faq/redirect-uri.md)
* [How can I import a custom CA for RethinkDB?](faq/rethink-ca.md)
* [How do I know if OAuth2 / Hydra is the right choice for me?](faq/when-use.md)
* [Operational considerations](faq/operations.md)
4 changes: 0 additions & 4 deletions docs/faq/redirect-uri.md

This file was deleted.

12 changes: 0 additions & 12 deletions docs/faq/rethink-ca.md

This file was deleted.

0 comments on commit 932f409

Please sign in to comment.