Update README
- commit
- b52f36942d5e85b747e0c8acc13ad8abe62a7313
- author
- bnema · · 2023-10-09 14:11 UTC
- parent
- 7ae9895
- signature
- unsigned
1 file · +11 -2
M README.md +11 -2
| @@ -9,11 +9,11 @@ | |||
| 9 | 9 | <h4 align="center">Minimalist self-hosted containerized app deployment tool.</h4> | |
| 10 | 10 | ||
| 11 | 11 | ||
| 12 | - | Gordon is a tool based on Golang that aims to simplify the deployment of your containerized 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. | |
| 12 | + | 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. | |
| 13 | 13 | ||
| 14 | 14 | ## **Key Features** | |
| 15 | 15 | ||
| 16 | - | - **Quick Deployment**: Deploy container images effortlessly using the command **`gordon deploy <image:version> -p 8080 -t gordon.sld.tld`** | |
| 16 | + | - **Quick Deployment**: Deploy container images effortlessly using the command **`gordon deploy <image:version> -p 8080:80 -t gordon.sld.tld`** | |
| 17 | 17 | - **Self-Hosted**: Operates within your existing self-hosted environment. | |
| 18 | 18 | - **Web UI**: Provides a simple web UI to manage your deployments, domains, exposed ports, and more. | |
| 19 | 19 | - **Automated Routing**: Collaborates with Traefik to automatically route your application to your desired domain or subdomain. | |
| @@ -28,6 +28,15 @@ I found myself spending excessive time manually deploying my containerized appli | |||
| 28 | 28 | ||
| 29 | 29 | 🛠️ **Note**: This project is currently under heavy development. A 0.1 release with basic features will be available soon. | |
| 30 | 30 | ||
| 31 | + | ## **TODO for 0.1 release** | |
| 32 | + | ||
| 33 | + | - [x] Basic web UI for managing deployments | |
| 34 | + | - [x] CRUD operations with the container engine | |
| 35 | + | - [ ] Improve authentication security | |
| 36 | + | - [ ] Interaction with the database | |
| 37 | + | - [ ] New version update mechanism (backup, rollback etc.) | |
| 38 | + | - [ ] Basic CLI to push images to the container engine | |
| 39 | + | ||
| 31 | 40 | ## **License** | |
| 32 | 41 | ||
| 33 | 42 | Gordon is licensed under the GPL-3.0 license. Please see the LICENSE file for more details. | |
| @@ -9,11 +9,11 @@ | |||||
| 9 | <h4 align="center">Minimalist self-hosted containerized app deployment tool.</h4> | 9 | <h4 align="center">Minimalist self-hosted containerized app deployment tool.</h4> | ||
| 10 | 10 | ||||
| 11 | 11 | ||||
| 12 | - | Gordon is a tool based on Golang that aims to simplify the deployment of your containerized 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. | 12 | + | 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. |
| 13 | 13 | ||||
| 14 | ## **Key Features** | 14 | ## **Key Features** | ||
| 15 | 15 | ||||
| 16 | - | - **Quick Deployment**: Deploy container images effortlessly using the command **`gordon deploy <image:version> -p 8080 -t gordon.sld.tld`** | 16 | + | - **Quick Deployment**: Deploy container images effortlessly using the command **`gordon deploy <image:version> -p 8080:80 -t gordon.sld.tld`** |
| 17 | - **Self-Hosted**: Operates within your existing self-hosted environment. | 17 | - **Self-Hosted**: Operates within your existing self-hosted environment. | ||
| 18 | - **Web UI**: Provides a simple web UI to manage your deployments, domains, exposed ports, and more. | 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. | 19 | - **Automated Routing**: Collaborates with Traefik to automatically route your application to your desired domain or subdomain. | ||
| @@ -28,6 +28,15 @@ I found myself spending excessive time manually deploying my containerized appli | |||||
| 28 | 28 | ||||
| 29 | 🛠️ **Note**: This project is currently under heavy development. A 0.1 release with basic features will be available soon. | 29 | 🛠️ **Note**: This project is currently under heavy development. A 0.1 release with basic features will be available soon. | ||
| 30 | 30 | ||||
| 31 | + | ## **TODO for 0.1 release** | |||
| 32 | + | ||||
| 33 | + | - [x] Basic web UI for managing deployments | |||
| 34 | + | - [x] CRUD operations with the container engine | |||
| 35 | + | - [ ] Improve authentication security | |||
| 36 | + | - [ ] Interaction with the database | |||
| 37 | + | - [ ] New version update mechanism (backup, rollback etc.) | |||
| 38 | + | - [ ] Basic CLI to push images to the container engine | |||
| 39 | + | ||||
| 31 | ## **License** | 40 | ## **License** | ||
| 32 | 41 | ||||
| 33 | Gordon is licensed under the GPL-3.0 license. Please see the LICENSE file for more details. | 42 | Gordon is licensed under the GPL-3.0 license. Please see the LICENSE file for more details. | ||