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 existing setup.
Web UI: Provides a simple web UI to manage your deployments, domains, exposed ports, and more.
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.
Minimal stack: Sqlite3 (no ORM) for the db, the web UI is built using Go templates, HTMX and Tailwind CSS
Simple authentication: Use Github OAuth to authenticate with the web UI and a token for the CLI.

[Demo Deploy]

Why ?

I found myself spending excessive time manually deploying my containerized applications via remote SSH. I needed a tool that would automate the process to quickly spin up my test environments, and since I was eager to learn Go, I decided to create it myself.

Installation / Getting Started / Usage

For detailed instructions, please refer to the wiki: https://github.com/bnema/gordon/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 (<3 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 existing setup.
18- **Web UI**: Provides a simple web UI to manage your deployments, domains, exposed ports, and more.
19- **Automated Routing**: Collaborates with Traefik to automatically route your application to your desired domain or subdomain.
20- **One binary**: Gordon follows the Golang philosophy of keeping things simple, offering a single binary for all functionalities.
21- **Minimal stack**: Sqlite3 (no ORM) for the db, the web UI is built using Go templates, HTMX and Tailwind CSS
22- **Simple authentication**: Use Github OAuth to authenticate with the web UI and a token for the CLI.
23
24![Demo Deploy](assets/vhs/demo_deploy.gif?raw=true)
25
26
27## **Why ?**
28
29I found myself spending excessive time manually deploying my containerized applications via remote SSH. I needed a tool that would automate the process to quickly spin up my test environments, and since I was eager to learn Go, I decided to create it myself.
30
31## **Installation / Getting Started / Usage**
32
33For detailed instructions, please refer to the wiki:  <https://github.com/bnema/gordon/wiki/>
34
35
36## **Development Status & Disclaimer**
37
38🛠️ **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.
39
40I 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!
41
42## **Roadmap beyond 0.1**
43
44- Bug fixes (obviously)
45- Add tests
46- Better error handling and logging
47- Sexier WebUI with more features while keeping it simple (spa)
48- Sexier CLI (<3 [Charm](https://github.com/charmbracelet))
49- Refined CLI to backend authentication process (utilizing GitHub OAuth Device flow)
50- `deploy` command with no params
51- `push` command
52- Templates for databases (mysql, postgresql, redis, etc.)
53
54Have suggestions? Feel free to open an issue!
55
56## **License**
57
58Gordon is licensed under the GPL-3.0 license. Please see the LICENSE file for more details.

README.md RawHistoryFolder