obitech/andes repository overview

⁠Andes

Andes is a self-hosted management tool for creating and deploying simple container "stacks" on a single host, reachable under a specific subdomain and with full TLS encryption powered by Let's Encrypt. Similiar to Traefik⁠ it allows multiple container environments to be reachable through a single webserver acting as reverse proxy, in this case Caddy⁠.

• Documentation⁠

Please be aware that this project is still under development. Functionality is limited, things might not happen as expected or just break.

⁠Getting started

⁠Using Vagrant

For this you will need Vagrant⁠ and VirtualBox⁠ installed.

⁠Clone the repo

git clone https://github.com/obitech/andes.git
cd andes/

⁠Start Vagrant

vagrant up
vagrant ssh

⁠Run the bootstrap script

Inside your virtual machine do:

cd /vagrant/andes
bash bootstrap.sh -H 192.168.70.10

⁠Acess andes

Vagrant set up your VM to run on a private network, so you can reach the frontend from your host on 192.168.70.10 and the api on 192.168.70.10/api.

⁠Running locally

⁠Clone the repo

git clone https://github.com/obitech/andes.git

⁠Run the bootstrap script

cd andes/andes/system
bash bootstrap.sh

Verify with docker container ls if the Caddy and andes container are running. You can then access the frontend via localhost and the api via localhost/api.

⁠Taking requests

All endpoints take JSON requests, you can use Postman⁠ or good old curl for testing. Check the documentation for a reference on the API endpoints.

⁠Acknowledgements

This project has been created as a project at TU Chemnitz⁠ and I want to thank Prof. Dr. Andres Müller and osi8⁠ for support. I also want to thank everyone over in the Docker and Caddy communities for creating and maintaing such amazing techologies (as well as documentation!).