Merge branch 'theolymp-master'

Merged PR #39
passbolt · Jul 31, 2017 · 59bd17d · 59bd17d
2 parents 3d07473 + eacbf5a
commit 59bd17d
Show file tree

Hide file tree

Showing 2 changed files with 68 additions and 68 deletions.
diff --git a/README.md b/README.md
@@ -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.
 
-`$ 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
 
@@ -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=<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
 
@@ -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:          Forces passbolt to redirect to SSL any non-SSL request
 
 ### Core file variables
 
-* salt
-* cipherseed
-* url: url of the passbolt installation
+* SALT:       a random string used by cakephp in security hashing methods
+* CIPHERSEED: a random string used by cakephp to encrypt/decrypt strings
+* URL:        URL of the passbolt installation (defaults to example.com)
 
 ### 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 [email protected])
-* 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 [email protected])
+* 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
 

diff --git a/bin/docker-entrypoint.sh b/bin/docker-entrypoint.sh
@@ -16,17 +16,17 @@ ssl_cert='/etc/ssl/certs/certificate.crt'
 gpg_gen_key() {
   su -m -c "$gpg --batch --gen-key <<EOF
     Key-Type: 1
-		Key-Length: ${key_length:-2048}
+		Key-Length: ${KEY_LENGTH:-2048}
 		Subkey-Type: 1
-		Subkey-Length: ${subkey_length:-2048}
-		Name-Real: ${key_name:-Passbolt default user}
-		Name-Email: ${key_email:-passbolt@yourdomain.com}
-		Expire-Date: ${key_expiration:-0}
+		Subkey-Length: ${SUBKEY_LENGTH:-2048}
+		Name-Real: ${KEY_NAME:-Passbolt default user}
+		Name-Email: ${KEY_EMAIL:-passbolt@yourdomain.com}
+		Expire-Date: ${KEY_EXPIRATION:-0}
 		%commit
 EOF" -ls /bin/bash nginx
 
-  su -m -c "$gpg --armor --export-secret-keys $key_email > $gpg_private_key" -ls /bin/bash nginx
-  su -m -c "$gpg --armor --export $key_email > $gpg_public_key" -ls /bin/bash nginx
+  su -m -c "$gpg --armor --export-secret-keys $KEY_EMAIL > $gpg_private_key" -ls /bin/bash nginx
+  su -m -c "$gpg --armor --export $KEY_EMAIL > $gpg_public_key" -ls /bin/bash nginx
 }
 
 gpg_import_key() {
@@ -39,48 +39,48 @@ gpg_import_key() {
 
 core_setup() {
   #Env vars:
-  # salt
-  # cipherseed
-  # url
+  # SALT
+  # CIPHERSEED
+  # URL
 
   local default_salt='DYhG93b0qyJfIxfs2guVoUubWwvniR2G0FgaC9mi'
   local default_seed='76859309657453542496749683645'
   local default_url='example.com'
 
   cp $core_config{.default,}
-  sed -i s:$default_salt:${salt:-$default_salt}:g $core_config
-  sed -i s:$default_seed:${cipherseed:-$default_seed}:g $core_config
+  sed -i s:$default_salt:${SALT:-$default_salt}:g $core_config
+  sed -i s:$default_seed:${CIPHERSEED:-$default_seed}:g $core_config
   sed -i "/$default_url/ s:\/\/::" $core_config
-  sed -i s:$default_url:${url:-$default_url}:g $core_config
+  sed -i s:$default_url:${URL:-$default_url}:g $core_config
   if [ "$ssl" != false ]; then
     sed -i s:http:https:g $core_config
   fi
 }
 
 db_setup() {
   #Env vars:
-  # db_host
-  # db_user
-  # db_pass
-  # db_name
+  # DB_HOST
+  # DB_USER
+  # DB_PASS
+  # DB_NAME
 
   local default_host='localhost'
   local default_user='user'
   local default_pass='password'
   local default_db='database_name'
 
   cp $db_config{.default,}
-  sed -i s:$default_host:${db_host:-db}:g $db_config
-  sed -i s:$default_user:${db_user:-passbolt}:g $db_config
-  sed -i s:$default_pass\',:${db_pass:-P4ssb0lt}\',:g $db_config
-  sed -i s:$default_db:${db_name:-passbolt}:g $db_config
+  sed -i s:$default_host:${DB_HOST:-db}:g $db_config
+  sed -i s:$default_user:${DB_USER:-passbolt}:g $db_config
+  sed -i s:$default_pass\',:${DB_PASS:-P4ssb0lt}\',:g $db_config
+  sed -i s:$default_db:${DB_NAME:-passbolt}:g $db_config
 }
 
 app_setup() {
   #Env vars:
-  # fingerprint
-  # registration
-  # ssl
+  # FINGERPRINT
+  # REGISTRATION
+  # SSL
 
   local default_home='/home/www-data/.gnupg'
   local default_public_key='unsecure.key'
@@ -94,20 +94,20 @@ app_setup() {
   sed -i s:$default_home:$gpg_home:g $app_config
   sed -i s:$default_public_key:serverkey.asc:g $app_config
   sed -i s:$default_private_key:serverkey.private.asc:g $app_config
-  sed -i s:$default_fingerprint:${fingerprint:-$auto_fingerprint}:g $app_config
-  sed -i "/force/ s:true:${ssl:-true}:" $app_config
+  sed -i s:$default_fingerprint:${FINGERPRINT:-$auto_fingerprint}:g $app_config
+  sed -i "/force/ s:true:${SSL:-true}:" $app_config
 }
 
 email_setup() {
   #Env vars:
-  # email_transport
-  # email_from
-  # email_host
-  # email_port
-  # email_timeout
-  # email_username
-  # email_password
-  # email_tls
+  # EMAIL_TRANSPORT
+  # EMAIL_FROM
+  # EMAIL_HOST
+  # EMAIL_PORT
+  # EMAIL_TIMEOUT
+  # EMAIL_USERNAME
+  # EMAIL_PASSWORD
+  # EMAIL_TLS
 
   local default_transport='Smtp'
   local default_from='[email protected]'
@@ -118,14 +118,14 @@ email_setup() {
   local default_password="''"
 
   cp $email_config{.default,}
-  sed -i s:$default_transport:${email_transport:-Smtp}:g $email_config
-  sed -i s:$default_from:${email_from:-contact@mydomain.local}:g $email_config
-  sed -i s:$default_host:${email_host:-localhost}:g $email_config
-  sed -i s:$default_port:${email_port:-587}:g $email_config
-  sed -i s:$default_timeout:${email_timeout:-30}:g $email_config
-  sed -i "0,/"$default_username"/s:"$default_username":'${email_username:-email_user}':" $email_config
-  sed -i "0,/"$default_password"/s:"$default_password":'${email_password:-email_password}':" $email_config
-  sed -i "0,/tls/s:false:'${email_tls:-false}':" $email_config
+  sed -i s:$default_transport:${EMAIL_TRANSPORT:-Smtp}:g $email_config
+  sed -i s:$default_from:${EMAIL_FROM:-contact@mydomain.local}:g $email_config
+  sed -i s:$default_host:${EMAIL_HOST:-localhost}:g $email_config
+  sed -i s:$default_port:${EMAIL_PORT:-587}:g $email_config
+  sed -i s:$default_timeout:${EMAIL_TIMEOUT:-30}:g $email_config
+  sed -i "0,/"$default_username"/s:"$default_username":'${EMAIL_USERNAME:-email_user}':" $email_config
+  sed -i "0,/"$default_password"/s:"$default_password":'${EMAIL_PASSWORD:-email_password}':" $email_config
+  sed -i "0,/tls/s:false:'${EMAIL_TLS:-false}':" $email_config
 
 }