karrot/README.md

30 lines
840 B
Markdown
Raw Normal View History

2022-09-29 17:33:06 +00:00
# karrot
2022-09-30 15:20:57 +00:00
Karrot is a free and open-source tool for grassroots initiatives and groups of people that want to coordinate face-to-face activities on a local, autonomous and voluntary basis.
2022-09-29 17:33:06 +00:00
<!-- metadata -->
* **Category**: Utilities
* **Status**: 3, stable
2022-09-30 15:20:57 +00:00
* **Image**: [`karrot-backend`](https://hub.docker.com/r/vlafvlaf/karrot_backend),4,upstream
* **Healthcheck**: Yes
2022-09-29 17:33:06 +00:00
* **Backups**: No
2022-09-30 15:20:57 +00:00
* **Email**: Yes
2022-09-29 17:33:06 +00:00
* **Tests**: No
* **SSO**: No
<!-- endmetadata -->
## Basic usage
1. Set up Docker Swarm and [`abra`]
2. `abra app new karrot`
3. `abra app config <karrot app name>`
4. `abra app deploy <karrot app name>`
2022-09-30 15:20:57 +00:00
## Configuration options
2022-09-29 17:33:06 +00:00
2022-09-30 15:20:57 +00:00
`MAXMIND_ACCOUNT_ID` and `MAXMIND_ACCOUNT_KEY` are API credentials from maxmind.com. You need an account there to get GeoIP data for Karrot.
2022-09-29 17:33:06 +00:00
[`abra`]: https://git.coopcloud.tech/coop-cloud/abra