README.en.md

English | Pусский

---

dopos/dcape

Docker-compose application environment

Dcape is a tool which helps to create environments for docker-applications deployment using GitOps technology. Dcape based on make and docker-compose and intended to solve the following tasks:

• using make up run applications which needs
  • shared port (ex. 80)
  • database
• using git push deploy applications remotely on single or several computers
• manage app configs through API or web-interface
• limit via given user group access to used applications interfaces
• support for letsencrypt wildcard-domains
• manage docker objects

Applications

For solving of above-mentioned tasks dcape uses docker-images of the following applications:

• shared port - traefik
  • database - postgresql
• deploy applications remotely - woodpecker (on every computer) and gitea on someone
• manage app configs - enfist
• limit access - narra, gitea organization used as user group
• wildcard-domains - powerdns
• manage docker objects - portainer

Documentation

See dopos.github.io/dcape

Dependensies

• linux
• docker
• sudo apt -y install git make sed curl jq bind9-dnsutils

Usage examples

Deploy app local

Requirements:

• linux computer with docker and dcape
• hostnames registered in /etc/hosts or internal DNS (for example - mysite.dev.test, www.mysite.dev.test) pointing to this computer

Static site with nginx

git clone https://github.com/dopos/dcape-app-nginx-sample.git
cd dcape-app-nginx-sample
make config-if APP_SITE=mysite.dev.test
# <edit .env>
make up
..
Creating mysite-dev-lan_www_1 ... done

That's all - http://mysite.dev.test/ and http://www.mysite.dev.test/ are working.

Install dcape without gitea

Requirements:

• linux computer with docker and dependensies installed
• DNS records for wildcard-domain *.srv1.domain.tld
• Gitea $AUTH_TOKEN created

MY_HOST=${MY_HOST:-srv1.domain.tld}
MY_IP=${MY_IP:-192.168.23.10}
LE_ADMIN=${LE_ADMIN:-admin@domain.tld}
GITEA_URL=${GITEA_URL:-https://git.domain.tld}
GITEA_ORG=${GITEA_ORG:-dcape}
GITEA_USER=${GITEA_USER:-dcapeadmin}

git clone https://github.com/dopos/dcape.git
..
cd dcape
make install ACME=wild DNS=wild DCAPE_DOMAIN=${MY_HOST} \
  TRAEFIK_ACME_EMAIL=${LE_ADMIN} \
  DCAPE_ADMIN_ORG=${GITEA_ORG} \
  DCAPE_ADMIN_USER=${GITEA_USER} \
  PDNS_LISTEN=${MY_IP}:53 \
  GITEA=${GITEA_URL} \
  AUTH_TOKEN=${TOKEN}
..
Running dc command: up -d db ns router vcs auth config cicd manager
Dcape URL: https://srv1.domain.tld
------------------------------------------
[+] Running 9/9
 ✔ Container dcape-cicd-agent-1  Running
 ✔ Container dcape-manager-1     Running
 ✔ Container dcape-auth-1        Running
 ✔ Container dcape-router-1      Running
 ✔ Container dcape-db-1          Healthy
 ✔ Container dcape-cicd-1        Running
 ✔ Container dcape-vcs-1         Running
 ✔ Container dcape-ns-1          Running
 ✔ Container dcape-config-1      Running

That's all - server srv1.domain.tld ready for apps deployment, used dcape applications are accessible via https://srv1.domain.tld.

License

The MIT License (MIT), see LICENSE.

Copyright (c) 2017-2021 Aleksei Kovrizhkin lekovr+dopos@gmail.com