32 lines
1.0 KiB
Markdown
32 lines
1.0 KiB
Markdown
# karrot
|
|
|
|
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.
|
|
|
|
<!-- metadata -->
|
|
|
|
* **Category**: Utilities
|
|
* **Status**: 3, stable
|
|
* **Image**: [`karrot-frontend`](https://codeberg.org/karrot/-/packages/container/karrot-backend)/[`karrot-frontend`](https://codeberg.org/karrot/-/packages/container/karrot-backend),4,upstream
|
|
* **Healthcheck**: Yes
|
|
* **Backups**: No
|
|
* **Email**: Yes
|
|
* **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>`
|
|
|
|
See [Karrot Self-hosting docs](https://docs.karrot.world/self-host/coop-cloud/getting-started) for more information.
|
|
|
|
## Configuration options
|
|
|
|
`MAXMIND_ACCOUNT_ID` and `MAXMIND_ACCOUNT_KEY` are API credentials from maxmind.com. You need an account there to get GeoIP data for Karrot.
|
|
|
|
[`abra`]: https://git.coopcloud.tech/coop-cloud/abra
|