https://github.com/vanyle/aiguillage
A configuration provider with a pretty GUI
https://github.com/vanyle/aiguillage
Last synced: 6 months ago
JSON representation
A configuration provider with a pretty GUI
- Host: GitHub
- URL: https://github.com/vanyle/aiguillage
- Owner: vanyle
- Created: 2024-07-27T19:53:22.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-12-08T22:52:08.000Z (10 months ago)
- Last Synced: 2024-12-08T23:26:42.009Z (10 months ago)
- Language: TypeScript
- Size: 141 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
🚇 Aiguillage
Tiny Configuration provider for micro services with a GUI.
## The concept
- Deploy Aiguillage on a single machine with a fixed IP/Hostname
- Aiguillage provides a GUI where you can see your services and their configuration
- Services can register themselves
- You can edit the configuration of a service
- Services can post logs and you can view these logs.
- A service can have multiple version and you can set per-version configuration
- A configuration is a key, value pair.
- An empty value ("") is the same as no value.
Aiguillage is packaged as a ~10Mb docker image and can be deployed on environments with limited resources.
## Example of use cases
- Providing secrets/environment variables to applications and being able to switch them easily
- Easily distinguishing between production, testing and local environment and managing the config for all of them
- Changing the database used by a service by changing the underlying IP used.
- Toggling feature flags on or off quickly
- Seeing logs of all your application in one centralized place
## Getting started
On a machine with docker installed, run:
```bash
docker-compose up
```
Or use the `ghcr.io/vanyle/aiguillage:latest` docker image.
More information in [the documentation](./DOC.md)
## Usage
A Go SDK is provided that services can use to register themselves, get/set their config and post logs.
These feature only use HTTP REST request so you can easily implement them yourself.