From 2403c17fbd09b07b13e08566dd6a71b802366376 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julian-Samuel=20Geb=C3=BChr?= Date: Mon, 10 Apr 2023 00:16:59 +0200 Subject: [PATCH 1/3] Add mail and user definded config options for GoToSocial --- docs/services/gotosocial.md | 7 +++++++ requirements.yml | 2 +- 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/services/gotosocial.md b/docs/services/gotosocial.md index 3558709..c3371fc 100644 --- a/docs/services/gotosocial.md +++ b/docs/services/gotosocial.md @@ -29,6 +29,13 @@ gotosocial_hostname: 'social.example.org' # https://docs.gotosocial.org/installation_guide/advanced/#can-i-host-my-instance-at-fediexampleorg-but-have-just-exampleorg-in-my-username # gotosocial_account_domain: "example.org" +# Uncomment and adjust the following lines to enable GTS to send emails (reports, notifications, password resets etc..) +# Check out https://docs.gotosocial.org/en/latest/configuration/smtp/ for a configuration reference +# gotosocial_smtp_host: 'smtp.example.org' +# gotosocial_smtp_username: ggotosocial@example.org +# gotosocial_smtp_password: yourpassword +# gotosocial_smtp_from: ggotosocial@example.org + ######################################################################## # # # /gotosocial # diff --git a/requirements.yml b/requirements.yml index 98f070b..ce4d4c3 100644 --- a/requirements.yml +++ b/requirements.yml @@ -60,7 +60,7 @@ version: v1.19.0-1 name: gitea - src: git+https://github.com/mother-of-all-self-hosting/ansible-role-gotosocial.git - version: v0.8.0-0 + version: v0.8.0-1 name: gotosocial - src: git+https://gitlab.com/etke.cc/roles/grafana.git version: v9.4.7-1 From 7f2159d542ec97bc81ccd38b8fde5f80b5ffd97d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julian-Samuel=20Geb=C3=BChr?= Date: Mon, 10 Apr 2023 08:05:40 +0200 Subject: [PATCH 2/3] Move advanced configuration into seperate paragraph --- docs/services/gotosocial.md | 35 ++++++++++++++++++++--------------- 1 file changed, 20 insertions(+), 15 deletions(-) diff --git a/docs/services/gotosocial.md b/docs/services/gotosocial.md index c3371fc..8690f52 100644 --- a/docs/services/gotosocial.md +++ b/docs/services/gotosocial.md @@ -21,21 +21,6 @@ gotosocial_enabled: true # Examples: ["gts.example.org","some.server.com"] gotosocial_hostname: 'social.example.org' -# Domain to use when federating profiles. It defaults to `gotosocial_hostname` but you can cange it when you want your server to be at -# eg., `gotosocial_hostname: gts.example.org`, but you want the domain on accounts to be "example.org" because it looks better -# or is just shorter/easier to remember. -# -# Please read the appropriate section of the installation guide before you go messing around with this setting: -# https://docs.gotosocial.org/installation_guide/advanced/#can-i-host-my-instance-at-fediexampleorg-but-have-just-exampleorg-in-my-username -# gotosocial_account_domain: "example.org" - -# Uncomment and adjust the following lines to enable GTS to send emails (reports, notifications, password resets etc..) -# Check out https://docs.gotosocial.org/en/latest/configuration/smtp/ for a configuration reference -# gotosocial_smtp_host: 'smtp.example.org' -# gotosocial_smtp_username: ggotosocial@example.org -# gotosocial_smtp_password: yourpassword -# gotosocial_smtp_from: ggotosocial@example.org - ######################################################################## # # # /gotosocial # @@ -59,6 +44,26 @@ to demote a user from admin to normal user. Refer to the [great official documentation](https://docs.gotosocial.org/en/latest/) for more information on GoToSocial. +## Advanced configuration + +You can use the following variables in your `vars.yml` to further configure GoToSocial, e.g. enable e-mail notifications. + +``` +# Domain to use when federating profiles. It defaults to `gotosocial_hostname` but you can cange it when you want your server to be at +# eg., `gotosocial_hostname: gts.example.org`, but you want the domain on accounts to be "example.org" because it looks better +# or is just shorter/easier to remember. +# +# Please read the appropriate section of the installation guide before you go messing around with this setting: +# https://docs.gotosocial.org/installation_guide/advanced/#can-i-host-my-instance-at-fediexampleorg-but-have-just-exampleorg-in-my-username +# gotosocial_account_domain: "example.org" + +# Uncomment and adjust the following lines to enable GTS to send emails (reports, notifications, password resets etc..) +# Check out https://docs.gotosocial.org/en/latest/configuration/smtp/ for a configuration reference +# gotosocial_smtp_host: 'smtp.example.org' +# gotosocial_smtp_username: gotosocial@example.org +# gotosocial_smtp_password: yourpassword +# gotosocial_smtp_from: gotosocial@example.org +``` ## Migrate an existing instance From 222f5b6a20be0bbd04a0ab69b5b203e3ab7223ab Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julian-Samuel=20Geb=C3=BChr?= Date: Mon, 10 Apr 2023 10:22:53 +0200 Subject: [PATCH 3/3] Restructure docs --- docs/services/gotosocial.md | 45 ++++++++++++++++++++----------------- 1 file changed, 25 insertions(+), 20 deletions(-) diff --git a/docs/services/gotosocial.md b/docs/services/gotosocial.md index 8690f52..fcd31ba 100644 --- a/docs/services/gotosocial.md +++ b/docs/services/gotosocial.md @@ -31,7 +31,31 @@ gotosocial_hostname: 'social.example.org' After installation, you can use `just run-tags gotosocial-add-user --extra-vars=username= --extra-vars=password= --extra-vars=email="` to create your a user. Change `--tags=gotosocial-add-user` to `--tags=gotosocial-add-admin` to create an admin account. -### Usage +## Advanced account domain configuration + +The account domain is the second part of a user handle in the Fediverse. If your handle is @username@example.org, `example.org` is your account domain. By default GoToSocial will use `gotosocial_hostname` that you provide as account domain e.g. `social.example.org`. You might want to change this by setting `gotosocial_account_domain` if you want the domain on accounts to be `example.org` because it looks better or is just shorter/easier to remember. + +**Warning** DO NOT change this change this after your server has already run once, or you will break things! + +If you decide to use this read [the appropriate section of the installation guide](https://docs.gotosocial.org/installation_guide/advanced/#can-i-host-my-instance-at-fediexampleorg-but-have-just-exampleorg-in-my-username=) as you will have to do some additional work on the base domain. + +```yaml +gotosocial_account_domain: "example.org" +``` + +## E-Mail configuration + +You can use the following variables in your `vars.yml` to enable e-mail notifications. + +```yml +# Check out https://docs.gotosocial.org/en/latest/configuration/smtp/ for a configuration reference +gotosocial_smtp_host: 'smtp.example.org' +gotosocial_smtp_username: gotosocial@example.org +gotosocial_smtp_password: yourpassword +gotosocial_smtp_from: gotosocial@example.org +``` + +## Usage After [installing](../installing.md), you can visit at the URL specified in `gotosocial_hostname` and should see your instance. Start to customize it at `social.example.org/admin`. @@ -44,26 +68,7 @@ to demote a user from admin to normal user. Refer to the [great official documentation](https://docs.gotosocial.org/en/latest/) for more information on GoToSocial. -## Advanced configuration -You can use the following variables in your `vars.yml` to further configure GoToSocial, e.g. enable e-mail notifications. - -``` -# Domain to use when federating profiles. It defaults to `gotosocial_hostname` but you can cange it when you want your server to be at -# eg., `gotosocial_hostname: gts.example.org`, but you want the domain on accounts to be "example.org" because it looks better -# or is just shorter/easier to remember. -# -# Please read the appropriate section of the installation guide before you go messing around with this setting: -# https://docs.gotosocial.org/installation_guide/advanced/#can-i-host-my-instance-at-fediexampleorg-but-have-just-exampleorg-in-my-username -# gotosocial_account_domain: "example.org" - -# Uncomment and adjust the following lines to enable GTS to send emails (reports, notifications, password resets etc..) -# Check out https://docs.gotosocial.org/en/latest/configuration/smtp/ for a configuration reference -# gotosocial_smtp_host: 'smtp.example.org' -# gotosocial_smtp_username: gotosocial@example.org -# gotosocial_smtp_password: yourpassword -# gotosocial_smtp_from: gotosocial@example.org -``` ## Migrate an existing instance