diff --git a/README.md b/README.md index 096a41d..eea68c8 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,31 @@ -# Mastodon +# Hometown -Your self-hosted, globally interconnected microblogging community +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/hometown) but with a fresh README. 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. -* **Category**: -* **Status**: -* **Image**: [`tootsuite/mastodon`](https://hub.docker.com/r/tootsuite/mastodon) -* **Healthcheck**: -* **Backups**: -* **Email**: -* **Tests**: -* **SSO**: + +- **Category**: +- **Status**: +- **Image**: [`decentral1se/hometown`](https://hub.docker.com/r/decentral1se/hometown) +- **Healthcheck**: +- **Backups**: +- **Email**: +- **Tests**: +- **SSO**: ## Basic usage 1. Set up Docker Swarm and [`abra`] 2. Deploy [`coop-cloud/traefik`] -3. `abra app new mastodon` +3. `abra app new hometown` 4. `abra app YOURAPPDOMAIN config` - be sure to change `DOMAIN` to something that resolves to - your Docker swarm box. Install the npm package webpush to create VAPID keys `npm install web-push -g && web-push generate-vapid-keys`. + your Docker swarm box. Install the npm package webpush to create VAPID keys `npm install web-push -g && web-push generate-vapid-keys`. 5. `abra app YOURAPPDOMAIN deploy --no-domain-poll`. App will fail for now. -6. `abra app mastodon run streaming rake db:setup` -7. Open the configured domain in your browser to finish set-up. To make an admin account `abra app mastodon run web "bin/tootctl accounts create coolusername --email helo@autonomic.zone --confirmed --role admin"` +6. `abra app hometown run streaming rake db:setup` +7. Open the configured domain in your browser to finish set-up. To make an admin account `abra app hometown run web "bin/tootctl accounts create coolusername --email helo@autonomic.zone --confirmed --role admin"` [`abra`]: https://git.autonomic.zone/autonomic-cooperative/abra [`coop-cloud/traefik`]: https://git.autonomic.zone/coop-cloud/traefik