Skip to content

Latest commit

 

History

History
93 lines (61 loc) · 3.29 KB

README.md

File metadata and controls

93 lines (61 loc) · 3.29 KB
Raw

Dokku

Docker powered mini-Heroku. The smallest PaaS implementation you've ever seen.

Requirements

Assumes Ubuntu 13 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 bootstrapper will install everything it needs.

Installing

$ wget -qO- j.mp/dokku-bootstrap | bash

This may take around 5 minutes. Certainly better than the several hours it takes to bootstrap Cloud Foundry.

Configuring

Set up a domain and a wildcard domain pointing to that host. Make sure /home/git/DOMAIN is set to this domain. By default it's set to whatever the hostname the host has.

You'll have to add a public key associated with a username as it says at the end of the bootstrapper. You'll do something like this from your local machine:

$ cat ~/.ssh/id_rsa.pub | ssh root@progriumapp.com "gitreceive upload-key progrium"

That's it!

Deploy an App

Right now Buildstep supports the Node.js, Ruby and Java buildpacks. It's not hard to add more, go add more! 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.

$ cd node-js-sample
$ git remote add progrium git@progriumapp.com:node-js-app
$ git push progrium 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)
remote: ----> Receiving node-js-app ... 
remote: -----> Building node-js-app ...
remote: Node.js app detected
remote: -----> Resolving engine versions

... blah blah blah ...

remote: -----> Application deployed:
remote:        http://node-js-app.progriumapp.com

You're done!

Advanced installation (for development)

The bootstrap script allows source git repository URLs to be overridden to include customizations from your own repositories. The GITRECEIVE_URL, BUILDSTEP_REPO and DOKKU_REPO environment variables may be set to override the defaults (see the bootstrap.sh script for how these apply):

Example:

$ wget j.mp/dokku-bootstrap
$ chmod +x bootstrap.sh
$ DOKKU_REPO=https://github.com/yourusername/dokku.git bootstrap.sh

Components

Ideas for Improvements

  • Custom domain support for apps
  • HTTPS support on default domain
  • Support more buildpacks (see Buildstep)
  • Use dokku as the system user instead of git
  • Heroku-ish commands to be run via SSH (like Dokuen)

Looking to keep codebase as simple and hackable as possible, so try to keep your line count down.

Things this project won't do

  • Multi-node. Not a huge leap, but this isn't the project for it. Maybe as Super Dokku.
  • Multitenancy. It's ready for it, but again, probably for Super Dokku.
  • Client app. Given the constraints, running commands remotely via SSH is fine.

Contributors

License

MIT