Skip to content

Latest commit

 

History

History
98 lines (68 loc) · 5.07 KB

gotosocial.md

File metadata and controls

98 lines (68 loc) · 5.07 KB

GoToSocial

The playbook can install and configure GotoSocial for you.

GoToSocial is a self-hosted ActivityPub social network server. With GoToSocial, you can keep in touch with your friends, post, read, and share images and articles.

See the project's documentation to learn what GotoSocial does and why it might be useful to you.

For details about configuring the Ansible role for GoToSocial, you can check them via:

Dependencies

This service requires the following other services:

Configuration

To enable this service, add the following configuration to your vars.yml file and re-run the installation process:

########################################################################
#                                                                      #
# gotosocial                                                           #
#                                                                      #
########################################################################

gotosocial_enabled: true

# Hostname that this server will be reachable at.
# DO NOT change this after your server has already run once, or you will break things!
# Examples: ["gts.example.org","some.server.com"]
gotosocial_hostname: 'social.example.com'

########################################################################
#                                                                      #
# /gotosocial                                                          #
#                                                                      #
########################################################################

Set a shorter domain for your handle (optional)

On ActivityPub-powered platforms like GoToSocial, the user handle consists of two parts: username and server. For example, if your handle is @[email protected], user is the username and social.example.com indicates the server.

By default, GoToSocial uses gotosocial_hostname that you provide for the server's domain, but you can use a shorter one without the subdomain (example.com). See this section on the role's documentation for details about how to set it up.

Warning

Configuring it must be done before starting GoToSocial for the first time. Once you have federated with someone, you cannot change your domain layout.

Usage

After running the command for installation, you can create user account(s).

Run this command to create an administrator user account:

just run-tags gotosocial-add-admin --extra-vars=username=USERNAME_HERE --extra-vars=password=PASSWORD_HERE --extra-vars=email=EMAIL_ADDRESS_HERE

Run this command to create a regular (non-administrator) user account:

just run-tags gotosocial-add-user --extra-vars=username=USERNAME_HERE --extra-vars=password=PASSWORD_HERE --extra-vars=email=EMAIL_ADDRESS_HERE

Now you should be able to visit the URL at the specified hostname like https://social.example.com and check your instance.

See this section on the role's documentation for details about how to use a CLI tool, etc.

Migrate an existing instance

You can migrate your existing GoToSocial instance to the server which you manage with the MASH playbook. It is also possible to migrate on the same server (from an existing GoToSocial instance to the new one to start managing it with the MASH playbook, for example).

See this section on the role's documentation for details.