Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aceberg/gans
Git+Ansible: watch git repo for changes and run only changed playbooks
https://github.com/aceberg/gans
ansible git golang self-hosted selfhosted
Last synced: 3 months ago
JSON representation
Git+Ansible: watch git repo for changes and run only changed playbooks
- Host: GitHub
- URL: https://github.com/aceberg/gans
- Owner: aceberg
- License: mit
- Created: 2023-01-04T18:29:24.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-01-23T15:30:46.000Z (almost 2 years ago)
- Last Synced: 2024-09-27T15:04:34.443Z (3 months ago)
- Topics: ansible, git, golang, self-hosted, selfhosted
- Language: Go
- Homepage: https://hub.docker.com/r/aceberg/gans
- Size: 824 KB
- Stars: 15
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/aceberg/gans/actions/workflows/main-docker.yml)
[](https://github.com/aceberg/gans/actions/workflows/binary-release.yml)
[](https://goreportcard.com/report/github.com/aceberg/gans)
[](https://codeclimate.com/github/aceberg/gans/maintainability)
gans
Git+Ansible: watch git repo for changes and run only changed playbooks
(Also, `gans` means goose in German)
- [Quick start](https://github.com/aceberg/gans#quick-start)
- [Usage](https://github.com/aceberg/gans#usage)
- [Config](https://github.com/aceberg/gans#config)
- [Options](https://github.com/aceberg/gans#options)
- [Thanks](https://github.com/aceberg/gans#thanks)
## Quick start
Make sure `/path/to/git/repo` leads to your Ansible git repo.
```sh
docker run --name gans \
-e "TZ=Asia/Novosibirsk" \
-v ~/.dockerdata/gans:/data/gans \
-v /path/to/git/repo:/gitrepo \
-p 8845:8845 \
aceberg/gans
```
Or use [docker-compose.yml](docker-compose.yml)
## Usage
Web interface is pretty self-explanatory. If you know Ansible, you shouldn't have any problems.
Important things about `gans`:
- It supports only local git repos for now. If you need to work with remote repo, you can pull it regularly with [git-syr](https://github.com/aceberg/git-syr) or your own cron script.
- I decided not to parse Ansible Inventory to reduce errors, so you need to enter hosts and groups manually on `Repo` page. `Gans` will work only with those hosts.
- SSH Keys are handled by Ansible Inventory or `ansible.cfg`. `Keys` page is only there to help you upload them and check their presence.
Example [ansible.cfg](examples/ansible.cfg) and [hosts.ini](examples/hosts.ini) can also help. To work correctly `ansible.cfg` shoul be at the `/` of git repo.
## Config
Configuration can be done through config file or environment variables
| Variable | Description | Default |
| -------- | ----------- | ------- |
| DB | Path to Database | /data/gans/sqlite.db |
| HOST | Listen address | 0.0.0.0 |
| PORT | Port for web GUI | 8845 |
| THEME | Any theme name from https://bootswatch.com in lowcase | cerulean |
| SHOW | How many lines to show on index page | 25 |
| YAMLPATH | Path to file where git repo is described | /data/gans/repo.yaml |
| KEYPATH | Path to ssh keys directory | /data/gans/ssh |
| LOGPATH | Path to log file | /data/gans/gans.log |
| INTERVAL | Interval between repo scans (s, m, h) | 5s |
| TZ | Set your timezone for correct time | "" |
## Options
| Key | Description | Default |
| -------- | ----------- | ------- |
| -d | Path to SQLite DB file | /data/gans/sqlite.db |
| -c | Path to config file | /data/gans/config.yaml |
| -l | Path to log file | /data/gans/gans.log |
| -r | Path to repo yaml file | /data/gans/repo.yaml |
## Thanks
- All go packages listed in [dependencies](https://github.com/aceberg/gans/network/dependencies)
- [Bootstrap](https://getbootstrap.com/)
- Themes: [Free themes for Bootstrap](https://bootswatch.com)
- Favicon and logo: [Goose icons created by Freepik - Flaticon](https://www.flaticon.com/free-icons/goose)