Release 0.3.4

use DOKKU_IMAGE (i.e. progrium/buildstep)

HISTORY.md

@@ -1,5 +1,20 @@
 # History
 
+## 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

Makefile

@@ -5,6 +5,7 @@ PLUGINHOOK_URL ?= https://s3.amazonaws.com/progrium-pluginhook/pluginhook_0.1.0_
 STACK_URL ?= https://github.com/progrium/buildstep.git
 PREBUILT_STACK_URL ?= https://github.com/progrium/buildstep/releases/download/2014-03-08/2014-03-08_429d4a9deb.tar.gz
 DOKKU_ROOT ?= /home/dokku
+PLUGINS_PATH ?= /var/lib/dokku/plugins
 
 # If the first argument is "vagrant-dokku"...
 ifeq (vagrant-dokku,$(firstword $(MAKECMDGOALS)))
@@ -23,12 +24,12 @@ install: dependencies stack copyfiles plugin-dependencies plugins version
 
 copyfiles: addman
 	cp dokku /usr/local/bin/dokku
-	mkdir -p /var/lib/dokku/plugins
+	mkdir -p ${PLUGINS_PATH}
-	find /var/lib/dokku/plugins -mindepth 2 -maxdepth 2 -name '.core' -printf '%h\0' | xargs -0 rm -Rf
+	find ${PLUGINS_PATH} -mindepth 2 -maxdepth 2 -name '.core' -printf '%h\0' | xargs -0 rm -Rf
 	find plugins/ -mindepth 1 -maxdepth 1 -type d -printf '%f\n' | while read plugin; do \
-	    rm -Rf /var/lib/dokku/plugins/$$plugin && \
+	    rm -Rf ${PLUGINS_PATH}/$$plugin && \
-	    cp -R plugins/$$plugin /var/lib/dokku/plugins && \
+	    cp -R plugins/$$plugin ${PLUGINS_PATH} && \
-	    touch /var/lib/dokku/plugins/$$plugin/.core; \
+	    touch ${PLUGINS_PATH}/$$plugin/.core; \
 	    done
 
 addman:

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.4/bootstrap.sh | sudo DOKKU_TAG=v0.3.4 bash
 
 ## Documentation
 

contrib/dokku-installer.rb

@@ -21,7 +21,7 @@ if ARGV[0] == "onboot"
   exit
 end
 
-version   = "v0.3.2"
+version   = "v0.3.4"
 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

contrib/dokku_client.sh

@@ -0,0 +1,32 @@
+if [ -z "$DOKKU_HOST" ]
+then
+	function dokku {
+		appname=$(git remote -v 2>/dev/null | grep dokku | head -n 1 | cut -f1 -d' ' | cut -f2 -d':' 2>/dev/null)
+		if [ "$?" != "0" ]
+		then
+			donotshift="YES"
+		fi
+		if [ "$1" = "create" ]
+		then
+			appname=$(echo "print(elfs.GenName())" | lua -l elfs)
+			if git remote add dokku dokku@$DOKKU_HOST:$appname
+			then
+				echo "-----> Dokku remote added at $DOKKU_HOST"
+				echo "-----> Application name is $appname"
+			else
+				echo "!      Dokku remote not added! Do you already have a dokku remote?"
+				return
+			fi
+			git push dokku master
+		else
+			if [ -z "$donotshift" ]
+			then
+				ssh dokku@$DOKKU_HOST $*
+				exit
+			fi
+			verb=$1
+			shift
+			ssh dokku@$DOKKU_HOST "$verb" "$appname" $@
+		fi
+	}
+fi

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.4/bootstrap.sh | sudo DOKKU_TAG=v0.3.4 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/$APP" ]] && echo "App $APP 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

@@ -1,14 +1,20 @@
 #!/usr/bin/env bash
 set -eo pipefail
+
+export DOKKU_DISTRO=${DOKKU_DISTRO:="ubuntu"}
+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
 
 [[ $DOKKU_TRACE ]] && set -x
 
-if [[ $(id -un) != "dokku" && $1 != plugins-install* ]]; then
+if [[ $(id -un) != "dokku" && $1 != plugins-install* && $1 != "plugins-update" ]]; then
-  sudo -u dokku -H $0 "$@"
+  sudo -u dokku -E -H $0 "$@"
   exit
 fi
 
@@ -36,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 progrium/buildstep /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
@@ -130,6 +136,10 @@ case "$1" in
     pluginhook dependencies
     ;;
 
+  plugins-update)
+    pluginhook update
+    ;;
+
   # temporary hack for https://github.com/progrium/dokku/issues/82
   deploy:all)
     for app in $(ls -d $DOKKU_ROOT/*/CONTAINER); do
@@ -139,17 +149,36 @@ 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
     plugins-install                                 Install active plugins
+    plugins-update                                  Update active plugins
 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

dokku.1

@@ -1,4 +1,4 @@
-.TH DOKKU 1 2014-05-10
+.TH DOKKU 1 2014-11-22
 .\"Make sure to change that date when you commit a change!
 .\"
 .SH NAME
@@ -15,6 +15,15 @@ work with plugins and inspect the current state of your server.
 .\"
 .SH OPTIONS
 .TP
+.BI apps:create " <app>"
+Create a new app.
+.TP
+.BI apps:destroy " <app>"
+Permanantly destroy an app.
+.TP
+.B apps
+List your apps.
+.TP
 .BI backup:import " file"
 Import dokku config files.
 .TP
@@ -33,18 +42,22 @@ Set one or more config vars for an app.
 .BI config:unset " <app> KEY1" \fR\ (KEY2\ \.\.\.)
 Remove one or more config vars from an app.
 .TP
-.BI delete " <app>"
-Delete an application.
-.TP
 .B help
 Print the list of commands.
 .TP
 .B logs \ \fI<app> \fR[\fI-t\fR]
 Show the last logs for an application (-t follows)
 .TP
+.BI nginx:import-ssl " <app>"
+Imports a tarball from stdin which should contain
+server\.crt and server\.key
+.TP
 .B plugins-install
 Install active plugins.
 .TP
+.B plugins-update
+Update active plugins.
+.TP
 .B plugins
 Print active plugins.
 .TP

plugins/00_dokku-standard/commands

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

plugins/00_dokku-standard/install

@@ -7,6 +7,8 @@ fi
 
 # temporary hack for https://github.com/progrium/dokku/issues/82
 # redeploys all apps after a reboot
+case "$DOKKU_DISTRO" in
+  ubuntu)
     cat<<EOF > /etc/init/dokku-redeploy.conf
 description "Dokku app redeploy service"
 
@@ -17,3 +19,21 @@ script
   sudo -i -u dokku /usr/local/bin/dokku deploy:all
 end script
 EOF
+    ;;
+
+  opensuse)
+    cat<<EOF > /etc/systemd/system/dokku-redeploy.service
+[Unit]
+Description=Dokku app redeploy service
+After=docker.target
+
+[Service]
+Type=simple
+User=dokku
+ExecStart=/usr/local/bin/dokku deploy:all
+
+[Install]
+WantedBy=multi-user.target
+EOF
+    ;;
+esac

plugins/apps/commands

@@ -72,4 +72,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

@@ -184,4 +184,8 @@ ${var}"
 EOF
     ;;
 
+  *)
+    exit $DOKKU_NOT_IMPLEMENTED_EXIT
+    ;;
+
 esac

plugins/git/commands

@@ -6,7 +6,7 @@ git_archive_all() {
   TMP_WORK_DIR=$(mktemp -d)
   chmod 755 $TMP_WORK_DIR
   unset GIT_DIR GIT_WORK_TREE
-  git clone $DOKKU_ROOT/$APP $TMP_WORK_DIR &> /dev/null
+  git clone -q $DOKKU_ROOT/$APP $TMP_WORK_DIR &> /dev/null
   pushd $TMP_WORK_DIR > /dev/null
   git config advice.detachedHead false
   git checkout $REV &> /dev/null
@@ -34,6 +34,13 @@ case "$1" in
     done
     ;;
 
+  git-upload-pack)
+    APP="$(echo $2 | perl -pe 's/(?<!\\)'\''//g' | sed 's/\\'\''/'\''/g')"
+    pluginhook git-pre-pull $APP
+    cat | git-upload-pack "$DOKKU_ROOT/$APP"
+    pluginhook git-post-pull $APP
+    ;;
+
   git-*)
     APP="$(echo $2 | perl -pe 's/(?<!\\)'\''//g' | sed 's/\\'\''/'\''/g')"
     APP_PATH=$DOKKU_ROOT/$APP
@@ -58,4 +65,8 @@ EOF
     cat
     ;;
 
+  *)
+    exit $DOKKU_NOT_IMPLEMENTED_EXIT
+    ;;
+
 esac

plugins/nginx-vhosts/commands

@@ -34,10 +34,15 @@ case "$1" in
     mv "$TEMP_DIR/server.key" "$DOKKU_ROOT/$APP/tls/server.key"
     rm -rf $TEMP_DIR
     ;;
+
   help | nginx:help)
     cat && cat<<EOF
     nginx:import-ssl <app>                          Imports a tarball from stdin; should contain server.crt and server.key
 EOF
     ;;
 
+  *)
+    exit $DOKKU_NOT_IMPLEMENTED_EXIT
+    ;;
+
 esac

plugins/nginx-vhosts/dependencies

@@ -1,8 +1,15 @@
 #!/bin/bash
 set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
 
-# latest stable NGINX 1.4.x with websocket support
+case "$DOKKU_DISTRO" in
+  ubuntu)
     apt-get install -qq -y software-properties-common python-software-properties
     add-apt-repository -y ppa:nginx/stable
     apt-get update
     apt-get install -qq -y nginx dnsutils
+    ;;
+
+  opensuse)
+    zypper -q in -y nginx bind-utils
+    ;;
+esac

plugins/nginx-vhosts/install

@@ -1,12 +1,18 @@
 #!/usr/bin/env bash
 set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
 
-if ! grep -q dokku-nginx-reload "/etc/sudoers"; then
+if [[ ! -f /etc/sudoers.d/dokku-nginx ]]; then
-  touch /etc/sudoers.tmp
+  case "$DOKKU_DISTRO" in
-  cp /etc/sudoers /tmp/sudoers.new
+    ubuntu)
-  echo "%dokku ALL=(ALL)NOPASSWD:/etc/init.d/nginx reload # dokku-nginx-reload" >> /tmp/sudoers.new
+      echo "%dokku ALL=(ALL) NOPASSWD:/etc/init.d/nginx reload" >> /etc/sudoers.d/dokku-nginx
-  EDITOR="cp /tmp/sudoers.new" visudo
+      ;;
-  rm /tmp/sudoers.new
+
+    opensuse)
+      echo "%dokku ALL=(ALL) NOPASSWD:/sbin/service nginx reload" >> /etc/sudoers.d/dokku-nginx
+      ;;
+  esac
+
+  chmod 0440 /etc/sudoers.d/dokku-nginx
 fi
 
 # if dokku.conf has not been created, create it
@@ -25,10 +31,19 @@ ssl_prefer_server_ciphers on;
 #ssl_certificate_key $DOKKU_ROOT/tls/server.key;
 EOF
 fi
-sed -i 's/# server_names_hash_bucket_size/server_names_hash_bucket_size/' /etc/nginx/nginx.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"
 fi
 
+case "$DOKKU_DISTRO" in
+  ubuntu)
     /etc/init.d/nginx start
+    ;;
+
+  opensuse)
+    /sbin/service nginx start
+    ;;
+esac

plugins/nginx-vhosts/post-delete

@@ -1,4 +1,12 @@
 #!/usr/bin/env bash
 set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
 
+case "$DOKKU_DISTRO" in
+  ubuntu)
     sudo /etc/init.d/nginx reload > /dev/null
+    ;;
+
+  opensuse)
+    sudo /sbin/service nginx reload > /dev/null
+    ;;
+esac

plugins/nginx-vhosts/post-deploy

@@ -101,8 +101,17 @@ EOF
 
   echo "-----> Running nginx-pre-reload"
   pluginhook nginx-pre-reload $APP $PORT
+
   echo "       Reloading nginx"
+  case "$DOKKU_DISTRO" in
+    ubuntu)
       sudo /etc/init.d/nginx reload > /dev/null
+      ;;
+
+    opensuse)
+      sudo /sbin/service nginx reload > /dev/null
+      ;;
+  esac
 else
   if [[ -f "$DOKKU_ROOT/$APP/URL" ]]; then
     echo "------> NO_VHOST set, deleting $APP/URL"
@@ -112,6 +121,15 @@ else
     echo "------> NO_VHOST set, deleting $APP/nginx.conf"
     rm "$DOKKU_ROOT/$APP/nginx.conf"
     echo "------> NO_VHOST set, reloading nginx after nginx.conf deletion"
+    case "$DOKKU_DISTRO" in
+      ubuntu)
+        sudo /etc/init.d/nginx reload > /dev/null
+        ;;
+
+      opensuse)
+        sudo /sbin/service nginx reload > /dev/null
+        ;;
+    esac
     sudo /etc/init.d/nginx reload > /dev/null
   fi
 fi