hometown/README.md

# Hometown

A supported fork of Mastodon that provides local posting and a wider range of content types.

This repository is a copy of [coop-cloud/mastodon](https://git.autonomic.zone/coop-cloud/mastodon) but with a fresh README and some Hometown specific configuration. It seems like a good idea to keep the deployment separate since the apps may diverge in their deployment or configuration instructions at some point despite best wishes to remain as mainline Mastodon as possible.

<!-- metadata -->

* **Category**: Apps
* **Status**:
* **Image**: [`decentral1se/hometown`](https://hub.docker.com/r/decentral1se/hometown)
* **Healthcheck**:
* **Backups**:
* **Email**:
* **Tests**:
* **SSO**:

<!-- endmetadata -->

## Basic usage

1. Set up Docker Swarm and [`abra`]
1. Deploy [`coop-cloud/traefik`]
1. `abra app new mastodon`
1. Follow the [secrets setup docs](#secrets-setup)
1. `abra app YOURAPPDOMAIN config` - be sure to change `DOMAIN` to something that resolves to your Docker swarm box
1. `abra app YOURAPPDOMAIN deploy` to deploy the app

You'll need to run a `docker exec -it <streaming-service-id> /bin/bash` and do the following:

```
export OTP_SECRET=$(cat /run/secrets/otp_secret)
export SECRET_KEY_BASE=$(cat /run/secrets/secret_key_base)
export DB_PASS=$(cat /run/secrets/db_password)
bundle exec rake db:setup
```

Then, on your host (outside of the containers), you'll need to fix permissions for the volume (see [#2](https://git.autonomic.zone/coop-cloud/hometown/issues/2)):

```
chown -R 991:991 /var/lib/docker/volumes/<service-name>_app/_data
```

And finally, within the `app` container, create an admin account:

```
export OTP_SECRET=$(cat /run/secrets/otp_secret)
export SECRET_KEY_BASE=$(cat /run/secrets/secret_key_base)
export DB_PASS=$(cat /run/secrets/db_password)
tootctl accounts create <username> --email <email> --confirmed --role admin
```

[`abra`]: https://git.autonomic.zone/autonomic-cooperative/abra
[`coop-cloud/traefik`]: https://git.autonomic.zone/coop-cloud/traefik

## Secrets setup

Mastodon expects secrets generated by specific tools. Uou can run these commands via the scripts interface with `abra`.

`abra app cmd <domain> secrets --local`
Switch up README 2021-05-27 19:20:18 +00:00			`# Hometown`
Initial commit 2021-05-07 11:34:21 +00:00
Switch up README 2021-05-27 19:20:18 +00:00			`A supported fork of Mastodon that provides local posting and a wider range of content types.`

Note further config [ci skip] 2021-06-23 15:37:00 +00:00			`This repository is a copy of [coop-cloud/mastodon](https://git.autonomic.zone/coop-cloud/mastodon) but with a fresh README and some Hometown specific configuration. It seems like a good idea to keep the deployment separate since the apps may diverge in their deployment or configuration instructions at some point despite best wishes to remain as mainline Mastodon as possible.`
Initial commit 2021-05-07 11:34:21 +00:00
			`<!-- metadata -->`
Switch up README 2021-05-27 19:20:18 +00:00
chore: fix README bullet formatting [ci skip] 2021-11-22 11:42:03 +00:00			`* Category: Apps`
			`* Status:`
			* Image: [`decentral1se/hometown`](https://hub.docker.com/r/decentral1se/hometown)
			`* Healthcheck:`
			`* Backups:`
			`* Email:`
			`* Tests:`
			`* SSO:`
Make space there 2021-05-28 10:56:17 +00:00
Initial commit 2021-05-07 11:34:21 +00:00			`<!-- endmetadata -->`

			`## Basic usage`

			1. Set up Docker Swarm and [`abra`]
Document secret insertion and format 2021-05-28 10:54:02 +00:00			1. Deploy [`coop-cloud/traefik`]
			1. `abra app new mastodon`
Add secrets step 2021-05-28 13:36:00 +00:00			`1. Follow the [secrets setup docs](#secrets-setup)`
			1. `abra app YOURAPPDOMAIN config` - be sure to change `DOMAIN` to something that resolves to your Docker swarm box
Add more docs [ci skip] 2021-06-23 15:35:51 +00:00			1. `abra app YOURAPPDOMAIN deploy` to deploy the app

			You'll need to run a `docker exec -it <streaming-service-id> /bin/bash` and do the following:

			```
			`export OTP_SECRET=$(cat /run/secrets/otp_secret)`
			`export SECRET_KEY_BASE=$(cat /run/secrets/secret_key_base)`
			`export DB_PASS=$(cat /run/secrets/db_password)`
			`bundle exec rake db:setup`
			```

			`Then, on your host (outside of the containers), you'll need to fix permissions for the volume (see [#2](https://git.autonomic.zone/coop-cloud/hometown/issues/2)):`

			```
			`chown -R 991:991 /var/lib/docker/volumes/<service-name>_app/_data`
			```

Update 'README.md' 2022-02-24 08:04:30 +00:00			And finally, within the `app` container, create an admin account:
Add more docs [ci skip] 2021-06-23 15:35:51 +00:00
			```
Update 'README.md' 2022-02-24 08:04:30 +00:00			`export OTP_SECRET=$(cat /run/secrets/otp_secret)`
			`export SECRET_KEY_BASE=$(cat /run/secrets/secret_key_base)`
			`export DB_PASS=$(cat /run/secrets/db_password)`
Add more docs [ci skip] 2021-06-23 15:35:51 +00:00			`tootctl accounts create <username> --email <email> --confirmed --role admin`
			```
Initial commit 2021-05-07 11:34:21 +00:00
			[`abra`]: https://git.autonomic.zone/autonomic-cooperative/abra
			[`coop-cloud/traefik`]: https://git.autonomic.zone/coop-cloud/traefik
Document secret insertion and format 2021-05-28 10:54:02 +00:00
			`## Secrets setup`

docs: use scripts interface 2022-05-09 05:51:47 +00:00			Mastodon expects secrets generated by specific tools. Uou can run these commands via the scripts interface with `abra`.
Document secret insertion and format 2021-05-28 10:54:02 +00:00
docs: use scripts interface 2022-05-09 05:51:47 +00:00			`abra app cmd <domain> secrets --local`