karrot/README.md

# 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
first working commit 2022-09-29 17:33:06 +00:00			`# karrot`

chore: publish 0.1.0+0.1.0 release 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.`
first working commit 2022-09-29 17:33:06 +00:00
			`<!-- metadata -->`

			`* Category: Utilities`
			`* Status: 3, stable`
Update readme 2024-03-29 16:30:08 +00:00			* Image: [`karrot-frontend`](https://codeberg.org/karrot/-/packages/container/karrot-backend)/[`karrot-frontend`](https://codeberg.org/karrot/-/packages/container/karrot-backend),4,upstream
chore: publish 0.1.0+0.1.0 release 2022-09-30 15:20:57 +00:00			`* Healthcheck: Yes`
first working commit 2022-09-29 17:33:06 +00:00			`* Backups: No`
chore: publish 0.1.0+0.1.0 release 2022-09-30 15:20:57 +00:00			`* Email: Yes`
first working commit 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>`

Update readme 2024-03-29 16:30:08 +00:00			`See [Karrot Self-hosting docs](https://docs.karrot.world/self-host/coop-cloud/getting-started) for more information.`

chore: publish 0.1.0+0.1.0 release 2022-09-30 15:20:57 +00:00			`## Configuration options`
first working commit 2022-09-29 17:33:06 +00:00
chore: publish 0.1.0+0.1.0 release 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.
first working commit 2022-09-29 17:33:06 +00:00
			[`abra`]: https://git.coopcloud.tech/coop-cloud/abra