Git Product home page Git Product logo

dokku's Introduction

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 [email protected] "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 [email protected]: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: -----> 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 URLs to be overridden to include customizations from your own repositories. The GITRECEIVE_URL 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

Upgrading

Dokku is in active development. You can update the deployment step and the build step separately. To update the deploy step (this is updated less frequently):

$ cd ~/dokku
$ git pull origin master
$ make install

More frequently, the build step is updated. This is where the app "stack" lives and where buildpacks are supported. You can update this by running:

$ cd ~/dokku/buildstep
$ git pull origin master
$ make build

Nothing needs to be restarted. Changes will take effect on the next push / deployment.

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.

License

MIT

dokku's People

Contributors

progrium avatar rnorth avatar soulou avatar

Stargazers

 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.