CommunEu
/
Passbolt
3
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update Readme to use of uppercase ENV-Variables

This commit is contained in:
Robin Parker 2017-07-28 01:09:19 +02:00 committed by GitHub
parent f33c90b280
commit 84b0f8cede
1 changed files with 26 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
README.md
View File

@ -37,7 +37,7 @@ $ docker run -e MYSQL_ROOT_PASSWORD=<your_root_password> \
Then you can start passbolt just by providing the database container ip in the `db_host` environment variable. Then you can start passbolt just by providing the database container ip in the `db_host` environment variable.
`$ docker run -e db_host=<mysql_container_ip> passbolt:local` `$ docker run -e DB_HOST=<mysql_container_ip> passbolt:local`
Once the process is done, just navigate to the following url in your browser: https://passbolt_container_ip 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) 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: 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=<mysql_container_ip> passbolt:local` `$ docker run -p host_port:443 -e DB_HOST=<mysql_container_ip> passbolt:local`
And access it using https://localhost:host_port 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 ### GnuPG key creation related variables
* key_length: gpg desired key length * KEY_LENGTH: gpg desired key length
* subkey_length: gpg desired subkey length * SUBKEY_LENGTH: gpg desired subkey length
* key_name: key owner name * KEY_NAME: key owner name
* key_email: key owner email address * KEY_EMAIL: key owner email address
* key_expiration: key expiration date * KEY_EXPIRATION: key expiration date
### App file variables ### App file variables
* fingerprint: GnuPG fingerprint * FINGERPRINT: GnuPG fingerprint
* registration: defines if users can register * REGISTRATION: defines if users can register
* ssl * SSL
### Core file variables ### Core file variables
* salt * SALT
* cipherseed * CIPHERSEED
* url: url of the passbolt installation * URL: url of the passbolt installation
### Database variables ### Database variables
* db_host: database hostname This param has to be specified either using env var or in database.php * 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_USER: database username (defaults to passbolt)
* db_pass: database password (defaults to P4ssb0lt) * DB_PASS: database password (defaults to P4ssb0lt)
* db_name: database name (defaults to passbolt) * DB_NAME: database name (defaults to passbolt)
### Email variables ### Email variables
* email_transport: transport protocol ( defaults to Smtp) * EMAIL_TRANSPORT: transport protocol ( defaults to Smtp)
* email_from: from email address ( defaults to contact@mydomain.local) * EMAIL_FROM: from email address ( defaults to contact@mydomain.local)
* email_host: server hostname ( defaults to localhost) * EMAIL_HOST: server hostname ( defaults to localhost)
* email_port: server port ( defaults to 587) * EMAIL_PORT: server port ( defaults to 587)
* email_timeout: timeout ( defaults to 30s) * EMAIL_TIMEOUT: timeout ( defaults to 30s)
* email_username: username for email server auth ( defaults to email_user) * EMAIL_USERNAME: username for email server auth ( defaults to email_user)
* email_password: password for email server auth ( defaults to email_password) * EMAIL_PASSWORD: password for email server auth ( defaults to email_password)
* email_tls: set tls, boolean ( defaults to false) * EMAIL_TLS: set tls, boolean ( defaults to false)
## Advanced configuration ## 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 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 Point your browser to the passbolt container ip or localhost:exposed_port