Release 0.3.9

Add documentation for user-env feature

.editorconfig

@@ -4,3 +4,8 @@ root = true
 insert_final_newline = true
 indent_style = space
 indent_size = 2
+
+[Makefile]
+insert_final_newline = true
+indent_style = tab
+indent_size = 4

HISTORY.md

@@ -1,9 +1,31 @@
 # History
 
+## 0.3.9
+
+- #787: @josegonzalez/@michaelhobbs Official user-env-compile plugin
+  - Uses ENV and APP/ENV files
+  - Supports old `BUILD_ENV` files (which are likely in wide-use)
+  - Allows user's to override globals with app-specific configuration
+  - Migrate `$DOKKU_ROOT/BUILD_ENV` to `$DOKKU_ROOT/ENV` if the former exists and the latter does not
+  - Drop `BUILD_ENV` support in favor of just `ENV` via a `mv` command
+  - Add default ENV with `CURL_TIMEOUT` and `CURL_CONNECT_TIMEOUT`
+- #811: @abossard Increased `server_names_hash_bucket_size` in nginx.conf to 512
+- #814: @josegonzalez Source files in $DOKKU_ROOT/.dokkurc directory and add `dokku trace` command
+- #816: @josegonzalez Add documentation for user-env feature
+
+## 0.3.8
+
+- #796: @josegonzalez Better vagrant documentation
+- #801: @joelvh Point users to upgrade guides
+- #805: @ademuk Fixed import-ssl server.crt/key check
+- #806: @josegonzalez Dokku pushes now happen as the dokku user, not git. Refs #796
+- #807: @josegonzalez Write proper nginx conf upon installation. Closes #799
+- #808: @josegonzalez Ensure makefiles are properly formatted
+
 ## 0.3.7
 
-- #788 @mmerickel fix apps plugin issues in 0.3.6
-- #789 @mmerickel do not output message when creating ENV file
+- #788: @mmerickel fix apps plugin issues in 0.3.6
+- #789: @mmerickel do not output message when creating ENV file
 
 ## 0.3.6
 

Makefile

@@ -91,6 +91,7 @@ count:
 	@find tests -type f | xargs cat | wc -l
 
 dokku-installer:
+	apt-get install -qq -y ruby
 	test -f /var/lib/dokku/.dokku-installer-created || gem install rack -v 1.5.2 --no-rdoc --no-ri
 	test -f /var/lib/dokku/.dokku-installer-created || gem install rack-protection -v 1.5.3 --no-rdoc --no-ri
 	test -f /var/lib/dokku/.dokku-installer-created || gem install sinatra -v 1.4.5 --no-rdoc --no-ri

README.md

@@ -10,7 +10,11 @@ Docker powered mini-Heroku. The smallest PaaS implementation you've ever seen. S
 
 To install the latest stable version of dokku, you can run the following bootstrapper command:
 
-    $ wget -qO- https://raw.github.com/progrium/dokku/v0.3.7/bootstrap.sh | sudo DOKKU_TAG=v0.3.7 bash
+    $ wget -qO- https://raw.github.com/progrium/dokku/v0.3.9/bootstrap.sh | sudo DOKKU_TAG=v0.3.9 bash
+
+### Upgrading
+
+[View the docs for upgrading](http://progrium.viewdocs.io/dokku/upgrading) from an older version of Dokku.
 
 ## Documentation
 

contrib/dokku-installer.rb

@@ -21,7 +21,7 @@ if ARGV[0] == "onboot"
   exit
 end
 
-version   = "v0.3.7"
+version   = "v0.3.9"
 dokku_root  = ENV["DOKKU_ROOT"] || "/home/dokku"
 admin_key   = `cat /root/.ssh/authorized_keys`.split("\n").first
 hostname  = `bash -c '[[ $(dig +short $HOSTNAME) ]] && echo $HOSTNAME || curl icanhazip.com'`.strip

docs/application-deployment.md

@@ -4,8 +4,8 @@ Now you can deploy apps on your Dokku. Let's deploy the [Heroku Node.js sample a
 
 ```
 $ cd node-js-sample
-$ git remote add progrium dokku@progriumapp.com:node-js-app
-$ git push progrium master
+$ git remote add dokku dokku@dokku.me:node-js-app
+$ git push dokku master
 Counting objects: 296, done.
 Delta compression using up to 4 threads.
 Compressing objects: 100% (254/254), done.
@@ -18,12 +18,12 @@ Total 296 (delta 25), reused 276 (delta 13)
 ... blah blah blah ...
 
 -----> Application deployed:
-       http://node-js-app.progriumapp.com
+       http://node-js-app.dokku.me
 ```
 
 You're done!
 
-Dokku only supports deploying from its master branch, so if you'd like to deploy a different local branch use: ```git push progrium <local branch>:master```
+Dokku only supports deploying from its master branch, so if you'd like to deploy a different local branch use: ```git push dokku <local branch>:master```
 
 Right now Buildstep supports buildpacks for Node.js, Ruby, Python, [and more](https://github.com/progrium/buildstep#supported-buildpacks). It's not hard to add more, [go add more](https://github.com/progrium/buildstep#adding-buildpacks)!
 Please check the documentation for your particular build pack as you may need to include configuration files (such as a Procfile) in your project root.
@@ -53,33 +53,33 @@ Alternatively, you may push an app to your dokku host with a name like "00-defau
 
 The name of remote repository is used as the name of application to be deployed, as for example above:
 
-    $ git remote add progrium git@progriumapp.com:node-js-app
-    $ git push progrium master
+    $ git remote add dokku dokku@dokku.me:node-js-app
+    $ git push dokku master
 
 Is deployed to,
 
     remote: -----> Application deployed:
-    remote:        http://node-js-app.progriumapp.com
+    remote:        http://node-js-app.dokku.me
 
-You can also specify fully qualified names, say `app.progrium.com`, as
+You can also specify fully qualified names, say `app.dokku.me`, as
 
-    $ git remote add progrium git@progriumapp.com:app.progrium.com
-    $ git push progrium master
+    $ git remote add dokku dokku@dokku.me:app.dokku.me
+    $ git push dokku master
 
 So, after deployment the application will be available at,
 
     remote: -----> Application deployed:
-    remote:        http://app.progrium.com
+    remote:        http://app.dokku.me
 
 This is in particular useful, then you want to deploy to root domain, as
 
-    $ git remote add progrium git@progriumapp.com:progrium.com
-    $ git push progrium master
+    $ git remote add dokku dokku@dokku.me:dokku.me
+    $ git push dokku master
 
     ... deployment ...
 
     remote: -----> Application deployed:
-    remote:        http://progrium.com
+    remote:        http://dokku.me
 
 # Removing a deployed app
 

docs/configuration-management.md

@@ -11,4 +11,6 @@ config:set <app> KEY1=VALUE1 [KEY2=VALUE2 ...] - set one or more config vars
 config:unset <app> KEY1 [KEY2 ...] - unset one or more config vars
 ```
 
-The variables are by default available only at run time, i.e. not when the application is being built/compiled. However there are [plugins](http://progrium.viewdocs.io/dokku/plugins) that can change that.
+The variables are available both at at run time and during the application build/compilation step. You no longer need a `user-env` plugin as Dokku handles this functionality in a way equivalent to how Heroku handles it.
+
+> Note: Global `BUILD_ENV` files are currently migrated into a global `ENV` file. Configuring your global `ENV` file is manual, and should be considered potentially dangerous as configuration applies to all applications.

docs/installation.md

@@ -11,7 +11,7 @@ Ubuntu 14.04 x64 x64. Ideally have a domain ready to point to your host. It's de
 To install the latest stable version of dokku, you can run the following bootstrapper command:
 
 ```bash
-wget -qO- https://raw.github.com/progrium/dokku/v0.3.7/bootstrap.sh | sudo DOKKU_TAG=v0.3.7 bash
+wget -qO- https://raw.github.com/progrium/dokku/v0.3.9/bootstrap.sh | sudo DOKKU_TAG=v0.3.9 bash
 ```
 
 ## Configuring
@@ -20,7 +20,7 @@ Set up a domain and a wildcard domain pointing to that host. Make sure `/home/do
 
 You'll have to add a public key associated with a username by doing something like this from your local machine:
 
-    $ cat ~/.ssh/id_rsa.pub | ssh progriumapp.com "sudo sshcommand acl-add dokku progrium"
+    $ cat ~/.ssh/id_rsa.pub | ssh dokku.me "sudo sshcommand acl-add dokku $USER"
 
 That's it!
 
@@ -110,6 +110,7 @@ sudo BUILD_STACK=true make install
     # - `BOX_MEMORY`
     # - `DOKKU_DOMAIN`
     # - `DOKKU_IP`.
+    cd path/to/dokku
     vagrant up
     ```
 

docs/plugins.md

@@ -208,8 +208,6 @@ Note: The following plugins have been supplied by our community and may not have
 | [SSH Deployment Keys](https://github.com/cedricziel/dokku-deployment-keys)<sup>2</sup>            | [cedricziel][]        | 2014-01-17: compatible with upstream/master |
 | [SSH Hostkeys](https://github.com/cedricziel/dokku-hostkeys-plugin)<sup>3</sup>                   | [cedricziel][]        | 2014-01-17: compatible with upstream/master |
 | [Supply env vars to buildpacks](https://github.com/cameron-martin/dokku-build-env)                | [cameron-martin][]    | Works with v0.2.3     |
-| [user-env-compile](https://github.com/musicglue/dokku-user-env-compile)<sup>1</sup>               | [musicglue][]         | Compatible with dokku master branch |
-| [user-env-compile](https://github.com/motin/dokku-user-env-compile)<sup>1</sup>                   | [motin][]             | Compatible with 0.2.1 |
 | [VHOSTS Custom Configuration](https://github.com/neam/dokku-nginx-vhosts-custom-configuration)    | [motin][]             | Compatible with 0.3.1 |
 | [Volume (persistent storage)](https://github.com/ohardy/dokku-volume)                             | [ohardy][]            | Compatible with 0.2.0 |
 
@@ -218,8 +216,6 @@ Note: The following plugins have been supplied by our community and may not have
 [98332de]: https://github.com/dyson/dokku-persistent-storage/commit/98332de4b5b640610bee535f4d5260263074e18b
 [a043e98]: https://github.com/stuartpb/dokku-bind-port/commit/a043e9892f4815b6525c850131e09fd64db5c1fa
 
-<sup>1</sup> Similar to the heroku-labs feature (see https://devcenter.heroku.com/articles/labs-user-env-compile)
-
 <sup>2</sup> Adds the possibility to add SSH deployment keys to receive private hosted packages
 
 <sup>3</sup> Adds the ability to add custom hosts to the containers known_hosts file to be able to ssh them easily (useful with deployment keys)

docs/remote-commands.md

@@ -1,11 +1,11 @@
 # Remote commands
 
-Dokku commands can be run over ssh. Anywhere you would run `dokku <command>`, just run `ssh -t dokku@progriumapp.com <command>`
+Dokku commands can be run over ssh. Anywhere you would run `dokku <command>`, just run `ssh -t dokku@dokku.me <command>`
 The `-t` is used to request a pty. It is highly recommended to do so.
 To avoid the need to type the `-t` option each time, simply create/modify a section in the `.ssh/config` on the client side, as follows:
 
 ```
-Host progriumapp.com
+Host dokku.me
 RequestTTY yes
 ```
 

docs/troubleshooting.md

@@ -43,11 +43,16 @@ __Solution:__
 
 The `remote rejected` error does not give enough information. Anything could have failed.
 
-Create a `/home/dokku/dokkurc` file containing the following :
+To enable dokku tracing, simply run the following command:
+
+    # Since 0.3.9
+    dokku trace
+
+In versions older than 0.3.9, you can create a `/home/dokku/dokkurc` file containing the following :
 
     export DOKKU_TRACE=1
 
-This will trace all of dokku's activity. If this does not help you create a pastebin or a gist containing the full log, and create an issue.
+This will trace all of dokku's activity. If this does not help you, create a [gist](https://gist.github.com) containing the full log, and create an issue.
 
 ***
 

dokku

@@ -10,6 +10,7 @@ export DOKKU_NOT_IMPLEMENTED_EXIT=10
 export DOKKU_VALID_EXIT=0
 
 [[ -f $DOKKU_ROOT/dokkurc ]] && source $DOKKU_ROOT/dokkurc
+[[ -d $DOKKU_ROOT/.dokkurc ]] && for f in $DOKKU_ROOT/.dokkurc/*; do source $f; done
 
 [[ $DOKKU_TRACE ]] && set -x
 

plugins/00_dokku-standard/commands

@@ -2,6 +2,24 @@
 set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
 
 case "$1" in
+  trace)
+    [[ -d $DOKKU_ROOT/.dokkurc ]] || mkdir -p $DOKKU_ROOT/.dokkurc
+    [[ "$2" == "on" ]] || [[ "$2" == "off" ]] || {
+      echo "Valid trace options are [on/off]"
+      exit 1
+    }
+
+    if [[ "$2" == "on" ]]; then
+      echo "Enabling dokku trace"
+      echo "export DOKKU_TRACE=1" > $DOKKU_ROOT/.dokkurc/DOKKU_TRACE
+    fi
+
+    if [[ "$2" == "off" ]]; then
+      echo "Disabling dokku trace"
+      rm -f $DOKKU_ROOT/.dokkurc/DOKKU_TRACE
+    fi
+    ;;
+
   delete)
     dokku apps:destroy $2
     ;;

plugins/build-env/pre-build

@@ -0,0 +1,31 @@
+#!/usr/bin/env bash
+set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+
+APP="$1"; IMAGE="dokku/$APP"; BUILD_ENV=""
+
+[[ -f "$DOKKU_ROOT/BUILD_ENV" ]] && cat "$DOKKU_ROOT/BUILD_ENV" >> "$DOKKU_ROOT/ENV" && rm "$DOKKU_ROOT/BUILD_ENV"
+
+[[ ! $(grep CURL_CONNECT_TIMEOUT "$DOKKU_ROOT/ENV") ]] && echo "export CURL_CONNECT_TIMEOUT=5" >> "$DOKKU_ROOT/ENV"
+[[ ! $(grep CURL_TIMEOUT "$DOKKU_ROOT/ENV") ]] && echo "export CURL_TIMEOUT=30" >> "$DOKKU_ROOT/ENV"
+
+if [[ -f "$DOKKU_ROOT/ENV" ]]; then
+  BUILD_ENV+=$(< "$DOKKU_ROOT/ENV")
+fi
+if [[ -f "$DOKKU_ROOT/$APP/ENV" ]]; then
+  BUILD_ENV+=" "
+  BUILD_ENV+=$(< "$DOKKU_ROOT/$APP/ENV")
+fi
+
+if [[ ! -z "$BUILD_ENV" ]]; then
+  echo "-----> Adding BUILD_ENV to build environment..."
+  # create build env files for use in buildpacks like this:
+  # https://github.com/niteoweb/heroku-buildpack-buildout/blob/5879fa3418f7d8e079f1aa5816ba1adde73f4948/bin/compile#L34
+  id=$(echo $BUILD_ENV |sed 's@export @@g'| docker run -i -a stdin $IMAGE /bin/bash -c "for ENV_VAR in `cat`; do echo \$ENV_VAR |sed 's@^\([^=]*\)=\(.*\)\$@echo \2 >/tmp/env/\1@g' >>/tmp/set_env.sh; done && mkdir -p /tmp/env && /bin/bash /tmp/set_env.sh")
+  test $(docker wait $id) -eq 0
+  docker commit $id $IMAGE > /dev/null
+
+  # create build env for 'old style' buildpacks and dokku plugins
+  id=$(echo "$BUILD_ENV" | docker run -i -a stdin $IMAGE /bin/bash -c "cat >> /app/.env")
+  test $(docker wait $id) -eq 0
+  docker commit $id $IMAGE > /dev/null
+fi

plugins/nginx-vhosts/commands

@@ -11,8 +11,8 @@ case "$1" in
     TEMP_DIR=`mktemp -d`
     cd $TEMP_DIR
     tar xvf - <&0
-    [[ -f "$TEMP_DIR/server.crt" ]] && echo "Tar archive missing server.crt" && exit 1
-    [[ -f "$TEMP_DIR/server.key" ]] && echo "Tar archive missing server.key" && exit 1
+    [[ ! -f "$TEMP_DIR/server.crt" ]] && echo "Tar archive missing server.crt" && exit 1
+    [[ ! -f "$TEMP_DIR/server.key" ]] && echo "Tar archive missing server.key" && exit 1
 
     mkdir -p "$DOKKU_ROOT/$APP/tls"
     mv "$TEMP_DIR/server.crt" "$DOKKU_ROOT/$APP/tls/server.crt"

plugins/nginx-vhosts/install

@@ -32,7 +32,37 @@ ssl_prefer_server_ciphers on;
 EOF
 fi
 
-echo 'server_names_hash_bucket_size 64;' >| /etc/nginx/conf.d/server_names_hash_bucket_size.conf
+cat<<EOF > /etc/nginx/nginx.conf
+user www-data;
+worker_processes auto;
+pid /run/nginx.pid;
+
+events {
+  worker_connections 768;
+}
+
+http {
+  sendfile on;
+  tcp_nopush on;
+  tcp_nodelay on;
+  keepalive_timeout 65;
+  types_hash_max_size 2048;
+
+  include /etc/nginx/mime.types;
+  default_type application/octet-stream;
+  access_log /var/log/nginx/access.log;
+  error_log /var/log/nginx/error.log;
+
+  gzip on;
+  gzip_disable "msie6";
+
+  include /etc/nginx/conf.d/*.conf;
+  include /etc/nginx/sites-enabled/*;
+}
+
+EOF
+
+echo 'server_names_hash_bucket_size 512;' >| /etc/nginx/conf.d/server_names_hash_bucket_size.conf
 
 if [[ ! -f  "$DOKKU_ROOT/VHOST" ]]; then
   [[ $(dig +short $(< "$DOKKU_ROOT/HOSTNAME")) ]] && cp "$DOKKU_ROOT/HOSTNAME" "$DOKKU_ROOT/VHOST"