README.md · gordon · git.bnema.dev

README.md Raw History Folder

Gordon is a tool written in Go that aims to simplify the deployment of your containerized web applications. It automates the process of integrating your locally built image into your self-hosted setup. Additionally, Gordon coordinates domain routing through Traefik, which needs to be pre-installed. This eliminates the need for manual configuration and streamlines the development process.

Key Features

Ease of use: Deploy container images effortlessly using the command gordon deploy.
Self-Hosted: Operates within your existing self-hosted environment and don't interfere with your setup.
Self-Updated: The client can update itself to the latest version with gordon update. The backend is updated by pulling the latest image from ghcr.io.
Minimal WebUI: Provides a simple web UI to manage your deployments, domains, exposed ports. Using a very minimal stack (sqlite3, Go templates, HTMX and Tailwind CSS).
Simple authentication: Use Github OAuth to authenticate with the web UI and a token for the CLI.
Automated Routing: Collaborates with Traefik to automatically route your application to your desired domain or subdomain.
One binary: Gordon follows the Golang philosophy of keeping things simple, offering a single binary for all functionalities.

[Demo Deploy]

Why ?

I needed a simple tool that would automate the process of quickly spin up my web apps and preferably not on someone else's computer. And since I wanted to learn Go, I decided to build it myself.

Installation / Getting Started / Usage

For detailed instructions, please refer to the wiki

Development Status & Disclaimer

🛠️ Note: Gordon is under heavy development and is absolutely not ready for production. Thank you in advance for taking the time to test it and report any issues you may encounter.

I also want to emphasize that I am far from being a Go expert yet. Hence, if you notice any poor practices, I welcome your feedback—respectfully, of course. It's a valuable part of the learning process!

Roadmap beyond 0.1

Bug fixes (obviously)
Add tests
Better error handling and logging
Sexier WebUI with more features while keeping it simple (spa)
Sexier CLI (💕 Charm)
Refined CLI to backend authentication process (utilizing GitHub OAuth Device flow)
deploy command with no params
push command
Templates for databases (mysql, postgresql, redis, etc.)

Have suggestions? Feel free to open an issue!

License

Gordon is licensed under the GPL-3.0 license. Please see the LICENSE file for more details.

source

1<h1 align="center">
2  <br>
3 <img src="https://github.com/bnema/gordon/blob/main/internal/webui/public/assets/imgs/gordon-mascot-mq-trsp.png?raw=true" alt="Gordon" width="192">
4  <br>
5  Gordon
6  <br>
7</h1>
8
9<h4 align="center">Minimalist self-hosted containerized app deployment tool.</h4>
10
11
12Gordon is a tool written in Go that aims to simplify the deployment of your containerized web applications. It automates the process of integrating your locally built image into your self-hosted setup. Additionally, Gordon coordinates domain routing through Traefik, which needs to be pre-installed. This eliminates the need for manual configuration and streamlines the development process.
13
14## **Key Features**
15
16- **Ease of use**: Deploy container images effortlessly using the command **`gordon deploy`**.
17- **Self-Hosted**: Operates within your existing self-hosted environment and don't interfere with your setup.
18- **Self-Updated**: The client can update itself to the latest version with `gordon update`. The backend is updated by pulling the latest image from ghcr.io.
19- **Minimal WebUI**: Provides a simple web UI to manage your deployments, domains, exposed ports. Using a very minimal stack (sqlite3, Go templates, HTMX and Tailwind CSS).
20- **Simple authentication**: Use Github OAuth to authenticate with the web UI and a token for the CLI.
21- **Automated Routing**: Collaborates with Traefik to automatically route your application to your desired domain or subdomain.
22- **One binary**: Gordon follows the Golang philosophy of keeping things simple, offering a single binary for all functionalities.
23
24![Demo Deploy](assets/vhs/demo_deploy.gif?raw=true)
25
26## **Why ?**
27
28I needed a simple tool that would automate the process of quickly spin up my web apps and preferably not on someone else's computer. And since I wanted to learn Go, I decided to build it myself.
29
30## **Installation / Getting Started / Usage**
31
32For detailed instructions, please refer to the [wiki](https://github.com/bnema/gordon/wiki/)
33
34- [Setting up Gordon’s Backend](https://github.com/bnema/gordon/wiki/Setting-up-Gordon%E2%80%99s-Backend)
35- [Setting up Gordon's Client](https://github.com/bnema/gordon/wiki/Setting-up-Gordon's-Client)
36- [Deploying your first app](https://github.com/bnema/gordon/wiki/First-deployment)
37
38
39## **Development Status & Disclaimer**
40
41🛠️ **Note**: Gordon is under heavy development and is absolutely not ready for production. Thank you in advance for taking the time to test it and report any issues you may encounter.
42
43I also want to emphasize that I am far from being a Go expert yet. Hence, if you notice any poor practices, I welcome your feedback—respectfully, of course. It's a valuable part of the learning process!
44
45## **Roadmap beyond 0.1**
46
47- Bug fixes (obviously)
48- Add tests
49- Better error handling and logging
50- Sexier WebUI with more features while keeping it simple (spa)
51- Sexier CLI (💕 [Charm](https://github.com/charmbracelet))
52- Refined CLI to backend authentication process (utilizing GitHub OAuth Device flow)
53- `deploy` command with no params
54- `push` command
55- Templates for databases (mysql, postgresql, redis, etc.)
56
57Have suggestions? Feel free to open an issue!
58
59## **License**
60
61Gordon is licensed under the GPL-3.0 license. Please see the LICENSE file for more details.

README.md RawHistoryFolder