krebbl/docco

Docker image for deploying docker-compose projects with a custom domain name.

What is Docco?

Docco is a docker image that aims to provide an easy way to deploy projects to a custom domain with a docker-compose file by just using git push.

The project is heavily inspired by the Heroku CLI and Dokku which make it very convenient to deploy Docker images or projects with a Dockerfile but do not support docker compose.

Getting started

System Requirements

To start using Docco you just need a server with a domain and docker + docker compose installed.

Installation

1. Start Docco with Docker-Compose

Add the following docker-compose.yml file to your server, configure the DEFAULT_EMAIL and the authorized_keys settings and start it via docker compose up -d.

version: "3.8"
services:
  nginx-proxy:
    image: nginxproxy/nginx-proxy
    container_name: nginx-proxy
    ports:
      - "80:80"
      - "443:443"
    volumes:
      - /var/run/docker.sock:/tmp/docker.sock:ro
      - letsencrypt-certs:/etc/nginx/certs
      - letsencrypt-vhost-d:/etc/nginx/vhost.d
      - letsencrypt-html:/usr/share/nginx/html
  letsencrypt-proxy:
    image: nginxproxy/acme-companion
    container_name: letsencrypt-proxy
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock:ro
      - letsencrypt-certs:/etc/nginx/certs
      - letsencrypt-vhost-d:/etc/nginx/vhost.d
      - letsencrypt-html:/usr/share/nginx/html
      - acme:/etc/acme.sh
    environment:
      - [email protected]
      - NGINX_PROXY_CONTAINER=nginx-proxy
  docco:
    image: krebbl/docco
    ports:
      - "2222:22"
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock:ro
      - /root/.ssh/authorized_keys:/home/docco/.ssh/authorized_keys:ro
      - docco-git:/git
      - docco-apps:/root/apps

networks:
  default:
    external: true
    name: nginx-proxy

volumes:
  letsencrypt-certs:
  letsencrypt-vhost-d:
  letsencrypt-html:
  acme:
  docco-git:
  docco-apps:

This will start an NGINX server and a letsencrypt proxy that will serve your project via HTTPS and a custom domain.

When the container is up and running you can start using Docco.

2. Create your first app

On your locale machine you can now run the following commands to create your first app:

# List all docco commands
$ ssh docco@<IP> -p 2222

# Create your first app
$ ssh docco@<IP> -p 2222 apps create foobar

# Set the DOMAIN for your app "foobar"
$ ssh docco@<IP> -p 2222 config set foobar DOMAIN=foobar.apps.myserver.com

# To set multiple DOMAINS just separate them via ,
$ ssh docco@<IP> -p 2222 config set foobar DOMAIN=foobar.apps.myserver.com,foobar2.apps.myserver.com

Hint: Make sure that your DNS entries for the server are set up correctly. The best way is to use a wildcard DNS entry like *.apps.myserver.com.

3. Deploy your app

Before you are ready to deploy your app you need to adjust your docker-compose file in the following way:

1. Add the external network nginx-proxy
2. Set the ENV vars for the custom domain and letsencrypt host
3. Add the nginx-proxy network to your app

Example:

version: "3.8"
services:
  myapp:
    image: wordpress:latest
    networks:
      - nginx # add the nginx network
    expose:
      - 80
    restart: unless-stopped
    environment:
      VIRTUAL_HOST: $DOMAIN # set the virtual host
      LETSENCRYPT_HOST: $DOMAIN # set the letsencrypt host
  # ...
  # under networks
  networks:
    # add the nginx network
    nginx:
      external: true
      name: nginx-proxy

Now you can simply push your project to the server:

# go to your project you want to deploy

# add the docco remote repository
$ git remote add docco docco@<IP>:2222/git/foobar

# push your code to docco
$ git push docco main

Once pushed Docco will look for a docker-compose.yml file and start the containers under the defined domain.

Go to foobar.apps.myserver.com and check out if everything is working. (It takes some seconds to generate the SSL certificates)

4. Destroy your app

If you want to destroy or remove your app you can run:

$ ssh docco@<IP> -p 2222 apps destroy foobar

5. Configure your app

To configure your app you can pass ENV vars to your docker compose file with the config command:

$ ssh docco@<IP> -p 2222 config set foobar VAR1=foo VAR2=bar

These configured ENV vars can be used inside the docker compose file and passed on to the different containers that are defined. For example:

    #...
    wordpress:
        depends_on:
          - db_node_domain
        image: wordpress:latest
        networks:
          - db
          - nginx
        expose:
          - 80
        restart: unless-stopped
        environment:
          FOO: $VAR1
          BAR: $VAR2
  #...