mash-playbook/docs/services/gotosocial.md

79 lines
3.1 KiB
Markdown
Raw Normal View History

2023-03-24 13:11:13 +01:00
# GoToSocial
2023-03-24 23:51:37 +01:00
[GoToSocial](https://gotosocial.org/) is a self-hosted [ActivityPub](https://activitypub.rocks/) social network server, that this playbook can install, powered by the [mother-of-all-self-hosting/ansible-role-gotosocial](https://github.com/mother-of-all-self-hosting/ansible-role-gotosocial) Ansible role.
2023-03-24 13:11:13 +01:00
## Configuration
To enable this service, add the following configuration to your `vars.yml` file and re-run the [installation](../installing.md) process:
```yaml
########################################################################
# #
# gotosocial #
# #
########################################################################
gotosocial_enabled: true
gotosocial_hostname: 'social.example.org'
########################################################################
# #
# /gotosocial #
# #
########################################################################
```
2023-03-24 15:35:53 +01:00
After installation, you can use `ansible-playbook -i inventory/hosts setup.yml --tags=gotosocial-add-user --extra-vars "username=<username> email=<email> password=<password>"`
to create your a user. Change `--tags=gotosocial-add-user` to `--tags=gotosocial-add-admin` to create an admin account.
2023-03-24 13:11:13 +01:00
### Usage
2023-03-24 15:35:53 +01:00
After [installing](../installing.md), you can visti at the URL specified in `firezone_hostname` and should see your instance.
Start to customize it at `social.example.org/admin`.
Use the [GtS CLI Tool](https://docs.gotosocial.org/en/latest/admin/cli/) to do admin & maintenance tasks. E.g. use
```bash
docker exec -it mash-gotosocial /gotosocial/gotosocial admin account demote --username <username>
```
to demote a user from admin to normal user.
2023-03-24 13:11:13 +01:00
2023-03-24 15:35:53 +01:00
Refer to the [great official documentation](https://docs.gotosocial.org/en/latest/) for more information on GoToSocial.
2023-03-29 10:02:55 +02:00
## Migrate an existing instance
The following assumes you want to migrate from `serverA` to `serverB` (managed by mash) but you just cave to adjust the copy commands if you are on the same server.
Stop the initial instance on `serverA`
```bash
serverA$ systemctl stop gotosocial
```
Dump the database (depending on your existing setup you might have to adjust this)
```
serverA$ pg_dump gotosocial > latest.sql
```
Copy the files to the new server
```bash
serverA$ rsync -av -e "ssh" latest.sql root@serverB:/mash/gotosocial/
serverA$ rsync -av -e "ssh" data/* root@serverB:/mash/gotosocial/data/
```
Install (but don't start) the service and database on the server.
```bash
yourPC$ ansible-playbook -i inventory/hosts setup.yml --tags=install-all
yourPC$ just run-tags import-postgres --extra-vars=server_path_postgres_dump=/mash/gotosocial/latest.sql --extra-vars=postgres_default_import_database=mash-gotosocial
```
Start the services on the new server
```bash
2023-03-29 10:54:51 +02:00
yourPC$ ansible-playbook -i inventory/hosts setup.yml --tags=start
2023-03-29 10:02:55 +02:00
```
Done 🥳