From 84b0f8cededcc647b3b1fc27435fa61bd11c846c Mon Sep 17 00:00:00 2001 From: Robin Parker Date: Fri, 28 Jul 2017 01:09:19 +0200 Subject: [PATCH] Update Readme to use of uppercase ENV-Variables --- README.md | 52 ++++++++++++++++++++++++++-------------------------- 1 file changed, 26 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index 5b62bda..ce93fd6 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,7 @@ $ docker run -e MYSQL_ROOT_PASSWORD= \ Then you can start passbolt just by providing the database container ip in the `db_host` environment variable. -`$ docker run -e db_host= passbolt:local` +`$ docker run -e DB_HOST= passbolt:local` Once the process is done, just navigate to the following url in your browser: https://passbolt_container_ip @@ -46,7 +46,7 @@ Once the process is done, just navigate to the following url in your browser: ht Due to the [limitations](https://docs.docker.com/docker-for-mac/networking/#known-limitations-use-cases-and-workarounds) of docker networking under MacOS users should start the container exposing a port on the host: -`$ docker run -p host_port:443 -e db_host= passbolt:local` +`$ docker run -p host_port:443 -e DB_HOST= passbolt:local` And access it using https://localhost:host_port @@ -58,41 +58,41 @@ Passbolt docker image provides several environment variables to configure differ ### GnuPG key creation related variables -* key_length: gpg desired key length -* subkey_length: gpg desired subkey length -* key_name: key owner name -* key_email: key owner email address -* key_expiration: key expiration date +* KEY_LENGTH: gpg desired key length +* SUBKEY_LENGTH: gpg desired subkey length +* KEY_NAME: key owner name +* KEY_EMAIL: key owner email address +* KEY_EXPIRATION: key expiration date ### App file variables -* fingerprint: GnuPG fingerprint -* registration: defines if users can register -* ssl +* FINGERPRINT: GnuPG fingerprint +* REGISTRATION: defines if users can register +* SSL ### Core file variables -* salt -* cipherseed -* url: url of the passbolt installation +* SALT +* CIPHERSEED +* URL: url of the passbolt installation ### Database variables -* db_host: database hostname This param has to be specified either using env var or in database.php -* db_user: database username (defaults to passbolt) -* db_pass: database password (defaults to P4ssb0lt) -* db_name: database name (defaults to passbolt) +* DB_HOST: database hostname This param has to be specified either using env var or in database.php +* DB_USER: database username (defaults to passbolt) +* DB_PASS: database password (defaults to P4ssb0lt) +* DB_NAME: database name (defaults to passbolt) ### Email variables -* email_transport: transport protocol ( defaults to Smtp) -* email_from: from email address ( defaults to contact@mydomain.local) -* email_host: server hostname ( defaults to localhost) -* email_port: server port ( defaults to 587) -* email_timeout: timeout ( defaults to 30s) -* email_username: username for email server auth ( defaults to email_user) -* email_password: password for email server auth ( defaults to email_password) -* email_tls: set tls, boolean ( defaults to false) +* EMAIL_TRANSPORT: transport protocol ( defaults to Smtp) +* EMAIL_FROM: from email address ( defaults to contact@mydomain.local) +* EMAIL_HOST: server hostname ( defaults to localhost) +* EMAIL_PORT: server port ( defaults to 587) +* EMAIL_TIMEOUT: timeout ( defaults to 30s) +* EMAIL_USERNAME: username for email server auth ( defaults to email_user) +* EMAIL_PASSWORD: password for email server auth ( defaults to email_password) +* EMAIL_TLS: set tls, boolean ( defaults to false) ## Advanced configuration @@ -132,7 +132,7 @@ $ docker run -e MYSQL_ROOT_PASSWORD=c0mplexp4ss \ Once mysql container is running we should extract its ip address. Let's assume 172.17.0.2 for this example -`$ docker run -e db_host=172.17.0.2 passbolt:local` +`$ docker run -e DB_HOST=172.17.0.2 passbolt:local` Point your browser to the passbolt container ip or localhost:exposed_port