Skip to content

Vagrant Installation Notes

  1. Download and install VirtualBox.

  2. Download and install Vagrant.

  3. Clone Dokku.

    git clone https://github.com/dokku/dokku.git
    
  4. Create VM.

    # Optional ENV arguments:
    # - `BOX_NAME`
    # - `BOX_URI`
    # - `BOX_MEMORY`
    # - `DOKKU_DOMAIN`
    # - `DOKKU_IP`
    # - `FORWARDED_PORT`.
    cd path/to/dokku
    
    # for most users
    vagrant up
    
    # windows users must instead use the following in an elevated command prompt
    vagrant up dokku-windows
    
  5. Setup SSH Config in ~/.ssh/config.

    Host dokku.me
        Port 22
    

    For users that have customized the IP address of their VM - either in a custom Vagrantfile or via the DOKKU_IP environment variable - and are not using 10.0.0.2 for the Vagrant IP, you'll need to instead use the output of vagrant ssh-config dokku for your ~/.ssh/config entry.

  6. Connect to the server via vagrant ssh and add your ssh key to the install. Additionally, set the global domain name to dokku.me.

    # usually your key is already available under the current user's `~/.ssh/authorized_keys` file
    cat ~/.ssh/authorized_keys | dokku ssh-keys:add admin
    
    # you can use any domain you already have access to
    dokku domains:set-global dokku.me
    

    Please note, the dokku.me domain is setup to point to 10.0.0.2 along with all subdomains (i.e. yourapp.dokku.me). If you change the DOKKU_IP in your Vagrant setup you'll need to update your /etc/hosts file to point your reconfigured IP address.

You are now ready to deploy an app or install plugins.