Docker powered mini-Heroku. The smallest PaaS implementation you've ever seen. It's fork of original dokku. The idea behind this fork is to provide complete solution with plugins covering most of use-cases which are stable and well tested.
- Debian-based installation and upgrade!
- Git deploy
- Built-in support for MariaDB, PostgreSQL, MongoDB and Redis databases
- Built-in support for Dockerfile
- Built-in support for service-only applications
- Built-in support for domains and redirects
- Built-in support for TLS and wildcard certificates
- Built-in support for Docker-args and container persistent volumes
- Built-in support for container's TOP
- Built-in support for foreman-based Procfile
- Data volumes with host-based volumes
- Preboot / zero-downtime deploy
- Enter and exec commands in already running containers
- Access-control: deploy only keys (BETA)
- Create-only application (BETA)
- HTTP-Basic Auth support (BETA)
- Simple SSL commands (BETA)
- SPDY and HSTS (BETA)
- Configure NGINX listen address (BETA)
- Support better image tagging
- Support for RabbitMQ and Memcached
- Support for custom nginx templates
- Support for application scaling
- Support for running buildstep-based applications as non-root user
- Support for
CHECKSas described in https://labnotes.org/zero-downtime-deploy-with-dokku/ - Full and incremental backup
- Application migration
Assumes that you use Ubuntu 14.04 LTS right now. Ideally have a domain ready to point to your host. It's designed for and is probably best to use a fresh VM. The debian package will install everything it needs.
$ sudo bash -c "$(curl -fsSL https://raw.githubusercontent.com/dokku-alt/dokku-alt/master/bootstrap.sh)"
Sometimes you may want to install dokku-alt completely non-interactive way. Now you can do it. Simply boostrap.sh without terminal:
$ sudo bash -c "$(curl -fsSL https://raw.githubusercontent.com/dokku-alt/dokku-alt/master/bootstrap.sh)" < /dev/null
If you use bootstrap script from above at the end it will fireup ruby installation script. Point your browser to http://<ip>:2000/ and finish configuration.
That's it!
Set up a domain and a wildcard domain pointing to that host. Make sure /home/dokku/VHOST is set to this domain. By default it's set to whatever hostname the host has. This file is only created if the hostname can be resolved by dig (dig +short $(hostname -f)). Otherwise you have to create the file manually and set it to your preferred domain. If this file still is not present when you push your app, dokku will publish the app with a port number (i.e. http://example.com:49154 - note the missing subdomain).
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 dokku.me "sudo sshcommand acl-add dokku dokku"
Unlike dokku this script uses debian packaging system (deb). To upgrade to latest version simply execute: sudo apt-get update && sudo apt-get install dokku-alt.
Alongside the normal (stable) releases we distribute as well beta (bleeding edge). To switch to beta simply execute: sudo apt-get update && sudo apt-get install dokku-alt-beta. It will replace the stable dokku-alt and switch to beta.
It should be possible, it should mostly work, but it's not tested and advised. VPS are very cheap this days so fire-up new machine and setup dokku-alt from the scratch.
Now you can deploy apps on your Dokku. Let's deploy the Heroku Node.js sample app. All you have to do is add a remote to name the app. It's created on-the-fly.
$ git clone https://github.com/heroku/node-js-sample
$ cd node-js-sample
$ git remote add dokku [email protected]:node-js-app
$ git push dokku master
Counting objects: 296, done.
Delta compression using up to 4 threads.
Compressing objects: 100% (254/254), done.
Writing objects: 100% (296/296), 193.59 KiB, done.
Total 296 (delta 25), reused 276 (delta 13)
-----> Building node-js-app ...
Node.js app detected
-----> Resolving engine versions
... blah blah blah ...
-----> Application deployed:
http://node-js-app.progriumapp.com
You're done!
Right now Buildstep supports buildpacks for Node.js, Ruby, Python, and more. It's not hard to add more, go add more! 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.
The key feature of the dokku-alt is built-in support for Dockerfiles, the docker build process. It allows you to create more advanced and more repetitive application environments.
To use Dockerfile simply put Dockerfile in root of the application, dokku-alt will detect it and build application according to specification in Dockerfile.
Dockerfile-based application can (but not required) to expose web-application port. dokku-alt will check if 80, 8080, 5000 is exposed. If it's it will update assign vhost and reconfigure nginx to forward all incoming traffic.
Using dockerfile you can built service-only applications. Simply don't expose public facing ports.
Example Dockerfile application: https://github.com/ayufan/dokku-alt-phpmyadmin
Dokku-alt has built-in support for additional domains and url redirects. By specifying redirects any client using that address will automatically be redirected to first domain assigned to the application.
Dokku commands can be run over ssh. Anywhere you would run dokku <command>, just run ssh -t [email protected] <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
RequestTTY yes
It's possible to run commands in the environment of the deployed application:
$ dokku run node-js-app ls -alh
$ dokku run <app> <cmd>
SSH onto the server, then execute:
$ dokku delete myapp
Dokku-alt allows you to create application before pushing it. It can be useful when you want to specify additional config variables or assign databases. Simply execute:
$ dokku create mynewapp
There's also possiblity to disable auto-application creation on push. Add to ~/dokkurc:
export DOKKU_DISABLE_AUTO_APP_CREATE=1
From now on you will have to do dokku create at first.
Dokku-alt allows you to add additional public keys to applications. The specific case is to add special deploy-only key, used for example by Countinous Integration (ie. Jenkins). Key added as deploy-only can only be used to git push specific application. It will not allowed to execute any on dokku commands. You can add ssh key and allow it explicit access to one or many applications.
Add locally:
$ cat .ssh/id_rsa.pub | dokku deploy:allow myapp
Add key remotely:
$ cat .ssh/id_rsa.pub | ssh dokku@dokku deploy:allow myapp
To later revoke key execute:
$ dokku deploy:revoke myapp FINGERPRINT
You can also list all fingerprints allowed to deploy an application:
$ dokku deploy:list myapp
Add a new admin user:
$ cat .ssh/id_rsa.pub | dokku access:add
Revoke permissions for admin user:
$ dokku access:revoke FINGERPRINT
Typically an application will require some environment variables to run properly. Environment variables may contain private data, such as passwords or API keys, so it is not recommend to store them in your application's repository.
The config plugin provides the following commands to manage your variables:
config <app> - display the config vars for an app
config:get <app> KEY - display a config value for an app
config:set <app> KEY1=VALUE1 [KEY2=VALUE2 ...] - set one or more config vars
config:unset <app> KEY1 [KEY2 ...] - unset one or more config vars
When you successfully deploy an app, you can tag it with your name and later in case of failure quickly revert back to that image.
$ dokku tag:add gitlab v6.9.0
=====> Tagged latest image of dokku/gitlab as v6.9.0
$ dokku tag:list gitlab
REPOSITORY TAG IMAGE ID CREATED VIRTUAL SIZE
dokku/gitlab build fc3baf1216d2 4 weeks ago 954.9 MB
dokku/gitlab latest fc3baf1216d2 4 weeks ago 954.9 MB
dokku/gitlab release fc3baf1216d2 4 weeks ago 954.9 MB
dokku/gitlab v6.9.0 fc3baf1216d2 4 weeks ago 954.9 MB
$ dokku deploy gitlab release <-- it will deploy GIT head
$ dokku deploy gitlab v6.9.0 <-- it will deploy tagged image
Dokku-alt has built-in support for all modern database engines: MariaDB (former MySQL), PostgreSQL and MongoDB. The database image will be downloaded and provisioned when first used.
First create database:
$ dokku mariadb:create test-db
-----> MariaDB database created: test-db
Second link database to an app:
$ dokku mariadb:link node-js-sample test-db
-----> Releasing node-js-sample ...
-----> Deploying node-js-sample ...
-----> Shutting down old containers
=====> Application deployed:
http://node-js-sample.ayufan.eu
Verify application env variables:
$ dokku config node-js-sample
=== node-js-sample config vars ===
DATABASE_URL: mysql2://node-js-sample:random-password@mariadb:3306/test-db
To use different database engine simple replace mariadb with postgresql or mongodb.
Similar to functionality provided by https://devcenter.heroku.com/articles/labs-preboot dokku-alt supports zero-downtime. To enable zero-downtime deployment execute command: dokku preboot:enable APP. Alongside with preboot there's checks plugin based on https://labnotes.org/zero-downtime-deploy-with-dokku/. For now it simply checks if application started serving requests. If checks module fails it will not replace the application.
Preboot and checks can be configured using a few env variables:
- PREBOOT_WAIT_TIME - number of seconds to wait for container boot (default 5s)
- PREBOOT_COOLDOWN_TIME - number of seconds to wait finish container request processing (default 30s)
- DOKKU_CHECKS_WAIT - number of seconds to wait before request retries (default 10s)
- DOKKU_CHECKS_TIMEOUT - number of seconds to wait for each response (default 20s)
- DOKKU_CHECKS_RETRY - number of retries (default 3)
Docker allows you to have persistent data storage. Dokku-alt exposes this feature as Data Volumes. You can create unlimited number of data volumes, any data volume can be attached to unlimited number of apps. Simply create data volume and specify container paths which you want to be persistant.
First data volume:
$ dokku volume:create shared-test-volume /app/logs /app/tmp /app/uploads
-----> Volume created: volume_data_shared-test-volume
Second link volume to an app:
$ dokku volume:link node-js-sample shared-test-volume
-----> Volume shared-test-volume linked to an aplication: node-js-sample
-----> Releasing node-js-sample ...
-----> Deploying node-js-sample ...
-----> Shutting down old containers
=====> Application deployed:
http://node-js-sample.ayufan.eu
It is just simple as this.
Dokku-alt allows you to bind host-based volumes in very simple manner. To use this feature you have to be logged as root and than simply type:
dokku volume:create host-based-volume /path/to/host/volume:/path/to/volume/in/container
Dokku-alt allows you to secure any application with HTTP-Basic Auth. There are a few commands that makes it happen:
htpasswd:add <app> <user> Add http-basic auth user
htpasswd:disable <app> Remove http-basic Auth
htpasswd:remove <app> <user> Remove user
If you want to enable and add a new user simply type command below and when prompted type your password twice:
dokku htpasswd:add myapp myuser
You can also pipe password:
echo mypass | dokku htpasswd:add myapp myuser
To revoke user's permission:
dokku htpasswd:remove myapp
To remove HTTP-Basic Auth completely:
dokku htpasswd:disable myapp
Dokku provides easy TLS support from the box. To enable TLS connection to your application, copy the .crt and .key files into the /home/dokku/:app/ssl folder (notice, file names should be server.crt and server.key, respectively). Redeployment of the application will be needed to apply TLS configuration. Once it is redeployed, the application will be accessible by https:// (redirection from http:// is applied as well).
Dokku-alt extends this even further by allowing you to use command line interface for certificates:
ssl:generate <app> Generate certificate signing request for an APP
ssl:certificate <app> Pipe signed certifcate with all intermediates for an APP
ssl:forget <app> Wipes certificate for an APP
ssl:info <app> Show info about certifcate and certificate request
ssl:key <app> Pipe private key for an APP
First use: dokku ssl:generate myapp to generate certificate signing request (CSR). At the end of process you will receive BEGIN CERTIFICATE REQUEST which you can ten copy-n-paste to your SSL signer (ie. http://startssl.com).
When you receive your signed certificate pipe it with ALL INTERMEDIATES to dokku ssl:certificate myapp. If done correctly you have SSL enabled for your site.
cat mycert.pem intermediate.pem ca.pem | dokku ssl:certificate myapp
If it happens that you have already created certificate you can use it, by piping your UNENCRYPTED your certificate and your private key:
cat mycert.pem intermediate.pem ca.pem | dokku ssl:certificate myapp
cat mycert.key | dokku ssl:key myapp
To view asigned certificate:
dokku ssl:info myapp
HTTP Strict Transport Security (HSTS) is a web security policy mechanism whereby a web server declares that complying user agents (such as a web browser) are to interact with it using only secure HTTPS connections. Once enabled all further communication will be done over TLS only, there's no revert mechanism. As this is additional security feature you have to do it by hand. To enable HSTS for site use:
dokku config:set myapp DOKKU_ENABLE_HSTS=1
By default dokku-alt for all TLS-enabled apps will create redirects which requires user to use https://. In some cases it maybe required to allow http:// access which is potentially insecure. To enable simulatenous HTTP and HTTPS set specific config:
dokku config:set myapp DOKKU_ENABLE_HTTP_HOST=1
You can fine-tune some aspects of Dokku behaviour and its plugins by setting variables in dokkurc file placed in Dokku root directory – usually /home/dokku. dokkurc is sourced by the main dokku script.
Example:
export DOKKU_DISABLE_AUTO_APP_CREATE=1
export BUILDSTEP_IMAGE="ayufan/dokku-alt-buildstep:foreman"
DOKKU_DISABLE_AUTO_APP_CREATE– when set to1, applications won't be automatically created on push; see Create only application.BUILDSTEP_IMAGE– buildstep image to be used by Docker, defaults toayufan/dokku-alt-buildstep:foreman.MARIADB_IMAGE– Docker image to be used for MariaDB plugin, defaults toayufan/dokku-alt-mariadb.MONGODB_IMAGE– Docker image to be used for MongoDB plugin, defaults toayufan/dokku-alt-mongodb.POSTGRESQL_IMAGE– Docker image to be used for PostgreSQL plugin, defaults toayufan/dokku-alt-postgresql.REDIS_IMAGE– Docker image to be used for Redis plugin, defaults toayufan/dokku-alt-redis.DOKKU_LISTEN_IPV4(BETA) - Set the IPV4 address on which NGINX will listen for requestsDOKKU_LISTEN_IPV6(BETA) - Set the IPV6 address on which NGINX will listen for requestsDOKKU_FORCE_ENABLE_HSTS(BETA) - Force to enable HSTS header (validity for one year) for all TLS-enabled appsDOKKU_DISABLE_NGINX_X_FORWARDED(BETA) - Disable setting ofX-Forwardedheaders by nginx, useful for CDN installations.
$ dokku help
apps:disable <app> Disable specific app
apps:enable <app> Re-enable specific app
apps:list List app
apps:restart <app> Restart specific app (not-redeploy)
apps:start <app> Stop specific app
apps:status <app> Status of specific app
apps:stop <app> Stop specific app
apps:top <app> [args...] Show running processes
backup:export [file] Export dokku configuration files
backup:import [file] Import dokku configuration files
config <app> display the config vars for an app
config:get <app> KEY display a config value for an app
config:set <app> KEY1=VALUE1 [KEY2=VALUE2 ...] set one or more config vars
config:unset <app> KEY1 [KEY2 ...] unset one or more config vars
delete <app> Delete an application
domains:get <app> Get domains for an app
domains:redirect:get <app> Get redirect domains for an app
domains:redirect:set <app> <domains...> Set redirect app domains
domains:set <app> <domains...> Set app domains
enter <app> Enter into currently running container
exec <app> <cmd> Execute command in currently running container
help Print the list of commands
logs <app> [-t] [-f] Show the last logs for an application (-t or -f follows)
mariadb:console <app> <db> Launch console for MariaDB container
mariadb:create <db> Create a MariaDB database
mariadb:delete <db> Delete specified MariaDB database
mariadb:dump <app> <db> Dump database for an app
mariadb:info <app> <db> Display application informations
mariadb:link <app> <db> Link database to app
mariadb:list <app> List linked databases
mariadb:unlink <app> <db> Unlink database from app
mongodb:console <app> <db> Launch console for MongoDB container
mongodb:create <db> Create a MongoDB database
mongodb:delete <db> Delete specified MongoDB database
mongodb:dump <app> <db> <collection> Dump database collection in bson for an app
mongodb:export <app> <db> <collection> Export database collection for an app
mongodb:import <app> <db> <collection> Import database collection for an app
mongodb:info <app> <db> Display application informations
mongodb:link <app> <db> Link database to app
mongodb:list <app> List linked databases
mongodb:unlink <app> <db> Unlink database from app
plugins-install Install active plugins
plugins Print active plugins
postgresql:console <app> <db> Launch console for PostgreSQL container
postgresql:create <db> Create a PostgreSQL database
postgresql:delete <db> Delete specified PostgreSQL database
postgresql:dump <app> <db> Dump database for an app
postgresql:info <app> <db> Display application informations
postgresql:link <app> <db> Link database to app
postgresql:list <app> List linked databases
postgresql:unlink <app> <db> Unlink database from app
preboot:cooldown:time <app> <secs> Re-enable specific app
preboot:disable <app> Stop specific app
preboot:enable <app> Stop specific app
preboot:status <app> Status of specific app
preboot:wait:time <app> <secs> Restart specific app (not-redeploy)
rebuild:all Rebuild all apps
rebuild <app> Rebuild an app
redis:create <app> Create a Redis database
redis:delete <app> Delete specified Redis database
redis:info <app> Display application information
run <app> <cmd> Run a command in the environment of an application
tag:add <app> <tag> Tag latest running image using specified name
tag:list <app> List all image tags
tag:rm <app> <tag> Tag latest running image using specified name
url <app> Show the URL for an application
version Print dokku's version
volume:create <name> <paths...> Create a data volume for specified paths
volume:delete <name> Delete a data volume
volume:info <name> Display volume information
volume:link <app> <name> Link volume to app
volume:list:apps <name> Display apps linked to volume
volume:list List volumes
volume:unlink <app> <name> Unlink volume from app
You can use Github Issues, check Troubleshooting on the wiki, or join us on freenode in #dokku
- Docker - Container runtime and manager
- Dokku - Orginal Dokku instance
- Buildstep - Buildpack builder
- pluginhook - Shell based plugins and hooks
- sshcommand - Fixed commands over SSH
MIT
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent