Release 0.3.7

This fixes a bug introduced when deploying apps where the
nginx-vhosts plugin runs ``dokku config:get $APP NO_VHOST``. The initial
run of this actually was creating the ``ENV`` file and dumping to
stdout the value "NO_VHOST=-----> Creating /home/dokku/foo/ENV". This
was obviously no good because nginx-vhosts was considering this to be a
value of true.

I've modified this to simply not return anything when the value does not
exist. A better update may be to output the messages to stderr instead
of stdout.

HISTORY.md

@@ -1,5 +1,34 @@
 # History
 
+## 0.3.7
+
+- #788 @mmerickel fix apps plugin issues in 0.3.6
+- #789 @mmerickel do not output message when creating ENV file
+
+## 0.3.6
+
+- #782: @josegonzalez Simplified config checking
+- #785: @lsde fix missing semicolon in nginx config
+
+## 0.3.5
+
+- #784: @josegonzalez Fix NO_VHOST check
+
+## 0.3.4
+
+- #780: @josegonzalez Output error message when a command is not found. Closes #778
+- #781: @michaelhobbs use DOKKU_IMAGE (i.e. progrium/buildstep)
+
+## 0.3.3
+
+- #659: @Xe contrib: add dokku client shell script
+- #669 @ohardy Handle dokku plugins-update command
+- #722: @wrboyce Add `git pull` support with git-pre-pull and git-post-pull hooks
+- #751: @tboerger Partial openSUSE support
+- #776: @joliv Update man page for new commands
+- #777: @tboerger Use PLUGINS_PATH env var and persist environment when running dokku with sudo
+- #779: @josegonzalez Minor bash formatting changes
+
 ## 0.3.2
 
 - #675: @michaelhobbs port wait-to-retire from broadly/dokku

README.md

@@ -10,7 +10,7 @@ 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.2/bootstrap.sh | sudo DOKKU_TAG=v0.3.2 bash
+    $ wget -qO- https://raw.github.com/progrium/dokku/v0.3.7/bootstrap.sh | sudo DOKKU_TAG=v0.3.7 bash
 
 ## Documentation
 

contrib/dokku-installer.rb

@@ -21,7 +21,7 @@ if ARGV[0] == "onboot"
   exit
 end
 
-version   = "v0.3.2"
+version   = "v0.3.7"
 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/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.2/bootstrap.sh | sudo DOKKU_TAG=v0.3.2 bash
+wget -qO- https://raw.github.com/progrium/dokku/v0.3.7/bootstrap.sh | sudo DOKKU_TAG=v0.3.7 bash
 ```
 
 ## Configuring

docs/plugins.md

@@ -28,6 +28,49 @@ If you create your own plugin:
 3. edit this page and add a link to it below!
 4. subscribe to the [dokku development blog](http://progrium.com) to be notified about API changes and releases
 
+### Sample plugin
+
+The below plugin is a dummy `dokku hello` plugin. If your plugin exposes commands, this is a good template for your `commands` file:
+
+```bash
+#!/usr/bin/env bash
+set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+
+case "$1" in
+  hello)
+    [[ -z $2 ]] && echo "Please specify an app to run the command on" && exit 1
+    [[ ! -d "$DOKKU_ROOT/$2" ]] && echo "App $2 does not exist" && exit 1
+    APP="$2";
+
+    echo "Hello $APP"
+    ;;
+
+  hello:world)
+    echo "Hello world"
+    ;;
+
+  help)
+    cat && cat<<EOF
+    hello <app>                                     Says "Hello <app>"
+    hello:world                                     Says "Hello world"
+EOF
+    ;;
+
+  *)
+    exit $DOKKU_NOT_IMPLEMENTED_EXIT
+    ;;
+
+esac
+```
+
+A few notes:
+
+- You should always support `DOKKU_TRACE` as specified on the 2nd line of the plugin.
+- If your command requires that an application exists, ensure you check for it's existence in the manner prescribed above.
+- A `help` command is required, though it is allowed to be empty.
+- Commands *should* be namespaced.
+- As of 0.3.3, a catch-all should be implemented which exits with a `DOKKU_NOT_IMPLEMENTED_EXIT` code. This allows dokku to output a `command not found` message.
+
 ## Community plugins
 
 Note: The following plugins have been supplied by our community and may not have been tested by dokku maintainers.

dokku

@@ -6,6 +6,8 @@ export DOKKU_IMAGE=${DOKKU_IMAGE:="progrium/buildstep"}
 export DOKKU_ROOT=${DOKKU_ROOT:="/home/dokku"}
 
 export PLUGIN_PATH=${PLUGIN_PATH:="/var/lib/dokku/plugins"}
+export DOKKU_NOT_IMPLEMENTED_EXIT=10
+export DOKKU_VALID_EXIT=0
 
 [[ -f $DOKKU_ROOT/dokkurc ]] && source $DOKKU_ROOT/dokkurc
 
@@ -40,7 +42,7 @@ case "$1" in
 
   build)
     APP="$2"; IMAGE="dokku/$APP"; CACHE_DIR="$DOKKU_ROOT/$APP/cache"
-    id=$(cat | docker run -i -a stdin $DOKKU_DISTRO /bin/bash -c "mkdir -p /app && tar -xC /app")
+    id=$(cat | docker run -i -a stdin $DOKKU_IMAGE /bin/bash -c "mkdir -p /app && tar -xC /app")
     test $(docker wait $id) -eq 0
     docker commit $id $IMAGE > /dev/null
     [[ -d $CACHE_DIR ]] || mkdir $CACHE_DIR
@@ -147,6 +149,9 @@ case "$1" in
     ;;
 
   help|'')
+    echo "Usage: dokku COMMAND <app> [command-specific-options]"
+    echo ""
+
     cat<<EOF | pluginhook commands help | sort
     help                                            Print the list of commands
     plugins                                         Print active plugins
@@ -156,9 +161,24 @@ EOF
     ;;
 
   *)
+    implemented=0
     for script in $(ls -d $PLUGIN_PATH/*/commands); do
-      $script "$@"
+      set +e; $script "$@" ; exit_code=$? ; set -e
+      if [ "$exit_code" -eq "$DOKKU_NOT_IMPLEMENTED_EXIT" ]; then
+        continue
+      fi
+
+      implemented=1
+      if [ "$exit_code" -ne "$DOKKU_VALID_EXIT" ]; then
+        exit $exit_code
+      fi
     done
+
+    if [ "$implemented" -eq 0 ]; then
+      echo " !    \`$@\` is not a dokku command."
+      echo " !    See \`dokku help\` for a list of available commands."
+      exit 1
+    fi
     ;;
 
 esac

plugins/00_dokku-standard/commands

@@ -7,15 +7,9 @@ case "$1" in
     ;;
 
   logs)
-    if [[ -z $2 ]]; then
-      echo "Please specify an app to run the command on"
-      exit 1
-    fi
+    [[ -z $2 ]] && echo "Please specify an app to run the command on" && exit 1
+    [[ ! -d "$DOKKU_ROOT/$2" ]] && echo "App $2 does not exist" && exit 1
     APP="$2";
-    if [[ ! -d "$DOKKU_ROOT/$APP" ]]; then
-      echo "App $APP does not exist"
-      exit 1
-    fi
 
     if [[ -f "$DOKKU_ROOT/$APP/CONTAINER" ]]; then
       CONTAINER=$(<$DOKKU_ROOT/$APP/CONTAINER)
@@ -30,15 +24,10 @@ case "$1" in
     ;;
 
   run)
-    if [[ -z $2 ]]; then
-      echo "Please specify an app to run the command on"
-      exit 1
-    fi
+    [[ -z $2 ]] && echo "Please specify an app to run the command on" && exit 1
+    [[ ! -d "$DOKKU_ROOT/$2" ]] && echo "App $2 does not exist" && exit 1
     APP="$2"; IMAGE="dokku/$APP"
-    if [[ ! -d "$DOKKU_ROOT/$APP" ]]; then
-      echo "App $APP does not exist"
-      exit 1
-    fi
+
     shift 2
 
     DOCKER_ARGS=$(: | pluginhook docker-args $APP)
@@ -46,11 +35,9 @@ case "$1" in
     ;;
 
   url)
+    [[ -z $2 ]] && echo "Please specify an app to run the command on" && exit 1
+    [[ ! -d "$DOKKU_ROOT/$2" ]] && echo "App $2 does not exist" && exit 1
     APP="$2";
-    if [[ ! -d "$DOKKU_ROOT/$APP" ]]; then
-      echo "App $APP does not exist"
-      exit 1
-    fi
 
     if [[ -f "$DOKKU_ROOT/$APP/URL" ]]; then
       echo $(< "$DOKKU_ROOT/$APP/URL")
@@ -73,4 +60,8 @@ case "$1" in
 EOF
     ;;
 
+  *)
+    exit $DOKKU_NOT_IMPLEMENTED_EXIT
+    ;;
+
 esac

plugins/apps/commands

@@ -4,39 +4,23 @@ set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
 case "$1" in
   apps)
     echo "=== My Apps"
-    find $DOKKU_ROOT -maxdepth 1 -type d  \( ! -iname ".*" \)  -not -path $DOKKU_ROOT/tls | sed 's|^\./||g' | sed 's|'$DOKKU_ROOT'\/||' | tail -n +2 | sort
+    find $DOKKU_ROOT -follow -maxdepth 1 -type d  \( ! -iname ".*" \)  -not -path $DOKKU_ROOT/tls | sed 's|^\./||g' | sed 's|'$DOKKU_ROOT'\/||' | tail -n +2 | sort
     ;;
 
   apps:create)
-    if [[ -z $2 ]]; then
-      echo "Please specify an app to create"
-      exit 1
-    fi
+    [[ -z $2 ]] && echo "Please specify an app to run the command on" && exit 1
+    [[ -d "$DOKKU_ROOT/$2" ]] && echo " !    Name is already taken" && exit 1
     APP="$2"
-    if [[ -d "$DOKKU_ROOT/$APP" ]]; then
-      echo " !    Name is already taken"
-      exit 1
-    fi
 
     mkdir -p "$DOKKU_ROOT/$APP"
     echo "Creating $APP... done"
     ;;
 
   apps:destroy)
-    if [[ -z $2 ]]; then
-      echo "Please specify an app to delete"
-      exit 1
-    fi
+    [[ -z $2 ]] && echo "Please specify an app to run the command on" && exit 1
+    [[ ! -d "$DOKKU_ROOT/$2" ]] && echo "App $2 does not exist" && exit 1
+    [[ "$2" == "tls" ]] && echo "Unable to destroy tls directory" && exit 1
     APP="$2"; IMAGE="dokku/$APP";
-    if [[ ! -d "$DOKKU_ROOT/$APP" ]]; then
-      echo "App $APP does not exist"
-      exit 1
-    fi
-
-    if [[ "$APP" == "tls" ]]; then
-      echo "Unable to destroy tls directory"
-      exit 1
-    fi
 
     echo " !    WARNING: Potentially Destructive Action"
     echo " !    This command will destroy $APP (including all add-ons)."
@@ -72,4 +56,8 @@ case "$1" in
 EOF
     ;;
 
+  *)
+    exit $DOKKU_NOT_IMPLEMENTED_EXIT
+    ;;
+
 esac

plugins/backup/commands

@@ -92,4 +92,8 @@ case "$1" in
 EOF
     ;;
 
+  *)
+    exit $DOKKU_NOT_IMPLEMENTED_EXIT
+    ;;
+
 esac

plugins/config/commands

@@ -1,28 +1,13 @@
 #!/usr/bin/env bash
 set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
 
-# Check if name is specified
-if [[ $1 == config ]] || [[ $1 == config:* ]]; then
-  if [[ -z $2 ]]; then
-    echo "You must specify an app name"
-    exit 1
-  else
-    APP="$2"
-    ENV_FILE="$DOKKU_ROOT/$APP/ENV"
-    ENV_FILE_TEMP="$DOKKU_ROOT/$APP/ENV.tmp"
-
-    # Check if app exists with the same name
-    if [ ! -d "$DOKKU_ROOT/$APP" ]; then
-      echo "App $APP does not exist"
-      exit 1
-    fi
-
-    [ -f $ENV_FILE ] || {
-      echo "-----> Creating $ENV_FILE"
-      touch $ENV_FILE
-    }
-  fi
-fi
+ENV_FILE="$DOKKU_ROOT/$2/ENV"
+ENV_FILE_TEMP="$DOKKU_ROOT/$2/ENV.tmp"
+config_create () {
+  [ -f $ENV_FILE ] || {
+    touch $ENV_FILE
+  }
+}
 
 config_styled_hash () {
   vars="$1"
@@ -76,12 +61,12 @@ config_write() {
 
 case "$1" in
   config)
+    [[ -z $2 ]] && echo "Please specify an app to run the command on" && exit 1
+    [[ ! -d "$DOKKU_ROOT/$2" ]] && echo "App $2 does not exist" && exit 1
     APP="$2"
 
-    if [ ! -f $ENV_FILE ] || [ ! -s $ENV_FILE ] ; then
-      echo "$APP has no config vars"
-      exit 1
-    fi
+    config_create
+    [[ ! -s $ENV_FILE ]] && echo "$APP has no config vars" && exit 1
 
     VARS=`cat $ENV_FILE | grep -Eo "export ([a-zA-Z_][a-zA-Z0-9_]*=.*)" | cut -d" " -f2-`
 
@@ -97,14 +82,19 @@ case "$1" in
     ;;
 
   config:get)
+    [[ -z $2 ]] && echo "Please specify an app to run the command on" && exit 1
+    [[ ! -d "$DOKKU_ROOT/$2" ]] && echo "App $2 does not exist" && exit 1
+    APP="$2"
+
     if [[ -z $3 ]]; then
       echo "Usage: dokku config:get APP KEY"
       echo "Must specify KEY."
       exit 1
     fi
 
-    if [ ! -f $ENV_FILE ] || [ ! -s $ENV_FILE ] ; then
-      exit 1
+    config_create
+    if [[ ! -s $ENV_FILE ]] ; then
+      exit 0
     fi
 
     KEY="$3"
@@ -113,13 +103,17 @@ case "$1" in
     ;;
 
   config:set)
+    [[ -z $2 ]] && echo "Please specify an app to run the command on" && exit 1
+    [[ ! -d "$DOKKU_ROOT/$2" ]] && echo "App $2 does not exist" && exit 1
+    APP="$2"
+
     if [[ -z "${*:3}" ]]; then
       echo "Usage: dokku config:set APP KEY1=VALUE1 [KEY2=VALUE2 ...]"
       echo "Must specify KEY and VALUE to set."
       exit 1
     fi
 
-    APP="$2"; APP_DIR="$DOKKU_ROOT/$APP"
+    config_create
     ENV_ADD=""
     ENV_TEMP=`cat "${ENV_FILE}"`
     RESTART_APP=false
@@ -157,13 +151,17 @@ ${var}"
     ;;
 
   config:unset)
+    [[ -z $2 ]] && echo "Please specify an app to run the command on" && exit 1
+    [[ ! -d "$DOKKU_ROOT/$2" ]] && echo "App $2 does not exist" && exit 1
+    APP="$2"
+
     if [[ -z $3 ]]; then
       echo "Usage: dokku config:unset APP KEY1 [KEY2 ...]"
       echo "Must specify KEY to unset."
       exit 1
     fi
 
-    APP="$2"; APP_DIR="$DOKKU_ROOT/$APP"
+    config_create
     ENV_TEMP=`cat "${ENV_FILE}"`
     VARS="${*:3}"
 
@@ -184,4 +182,8 @@ ${var}"
 EOF
     ;;
 
+  *)
+    exit $DOKKU_NOT_IMPLEMENTED_EXIT
+    ;;
+
 esac

plugins/git/commands

@@ -65,4 +65,8 @@ EOF
     cat
     ;;
 
+  *)
+    exit $DOKKU_NOT_IMPLEMENTED_EXIT
+    ;;
+
 esac

plugins/nginx-vhosts/commands

@@ -3,31 +3,16 @@ set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
 
 case "$1" in
   nginx:import-ssl)
-    if [[ -z $2 ]]; then
-      echo "Please specify an app to create"
-      exit 1
-    fi
+    [[ -z $2 ]] && echo "Please specify an app to run the command on" && exit 1
+    [[ ! -d "$DOKKU_ROOT/$2" ]] && echo "App $2 does not exist" && exit 1
+    [[ -t 0 ]] && echo "Tar archive containing server.crt and server.key expected on stdin" && exit 1
     APP="$2"
-    if [[ ! -d "$DOKKU_ROOT/$APP" ]]; then
-      echo "App $APP does not exist"
-      exit 1
-    fi
-    if [[ -t 0 ]]; then
-      echo "Tar archive containing server.crt and server.key expected on stdin"
-      exit 1
-    fi
 
     TEMP_DIR=`mktemp -d`
     cd $TEMP_DIR
     tar xvf - <&0
-    if [[ -f "$TEMP_DIR/server.crt" ]]; then
-      echo "Tar archive missing server.crt"
-      exit 1
-    fi
-    if [[ -f "$TEMP_DIR/server.key" ]]; then
-      echo "Tar archive missing server.key"
-      exit 1
-    fi
+    [[ -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"
@@ -41,4 +26,8 @@ case "$1" in
 EOF
     ;;
 
+  *)
+    exit $DOKKU_NOT_IMPLEMENTED_EXIT
+    ;;
+
 esac

plugins/nginx-vhosts/install

@@ -32,7 +32,7 @@ ssl_prefer_server_ciphers on;
 EOF
 fi
 
-echo 'server_names_hash_bucket_size 64' >| /etc/nginx/conf.d/server_names_hash_bucket_size.conf
+echo 'server_names_hash_bucket_size 64;' >| /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"

plugins/nginx-vhosts/post-deploy

@@ -9,11 +9,11 @@ set +e
 NO_VHOST=$(dokku config:get $APP NO_VHOST)
 set -e
 
-if [[ -z "$NO_VHOST" ]]; then
+if [[ -n "$NO_VHOST" ]]; then
   echo "-----> NO_VHOST config detected"
 fi
 
-if [[ -f "$DOKKU_ROOT/VHOST" && ! -z "$NO_VHOST" ]]; then
+if [[ -f "$DOKKU_ROOT/VHOST" && ! -n "$NO_VHOST" ]]; then
   VHOST=$(< "$DOKKU_ROOT/VHOST")
   SUBDOMAIN=${APP/%\.${VHOST}/}
   hostname=$(: | pluginhook nginx-hostname $APP $SUBDOMAIN $VHOST)