From 9c5153055ed7aee0423e3accee14e788db4105b9 Mon Sep 17 00:00:00 2001 From: OniriCorpe Date: Mon, 7 Mar 2022 21:14:10 +0100 Subject: [PATCH] update readmes with screenshot & disclaimer --- README.md | 42 +++++++++++++++++++++++++++++++----------- README_fr.md | 42 +++++++++++++++++++++++++++++++----------- 2 files changed, 62 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index d1cd61d..f8ef427 100644 --- a/README.md +++ b/README.md @@ -23,22 +23,42 @@ GoToSocial is an ActivityPub social network server, written in Golang. With GoTo ## Screenshots -![](./doc/screenshots/example.jpg) +![](./doc/screenshots/screenshot.jpg) ## Disclaimers / important information * Any known limitations, constrains or stuff not working, such as (but not limited to): - * requiring a full dedicated domain ? - * architectures not supported ? - * not-working single-sign on or LDAP integration ? - * the app requires an important amount of RAM / disk / .. to install or to work properly - * etc... + * GoToSocial require a dedicated root domain, eg. gotosocial.domain.tld + * This package is not-working single-sign on or LDAP integration + * This package is currently set to single-instance that means you can run a single GoToSocial instance on a single server. -* Other infos that people should be aware of, such as: - * any specific step to perform after installing (such as manually finishing the install, specific admin credentials, ...) - * how to configure / administrate the application if it ain't obvious - * upgrade process / specificities / things to be aware of ? - * security considerations ? +## Create and confirm your user + +You can use the GoToSocial binary to also create, confirm, and promote your user account. + +Run the following command to create a new account: + +```bash +./gotosocial --config-path ./config.yaml admin account create --username some_username --email some_email@whatever.org --password SOME_PASSWORD +``` + +In the above command, replace `some_username` with your desired username, `some_email@whatever.org` with the email address you want to associate with your account, and `SOME_PASSWORD` with a secure password. + +Run the following command to confirm the account you just created: + +```bash +./gotosocial --config-path ./config.yaml admin account confirm --username some_username +``` + +Replace `some_username` with the username of the account you just created. + +If you want your user to have admin rights, you can promote them using a similar command: + +```bash +./gotosocial --config-path ./config.yaml admin account promote --username some_username +``` + +Replace `some_username` with the username of the account you just created. ## Documentation and resources diff --git a/README_fr.md b/README_fr.md index 485afa8..ced6614 100644 --- a/README_fr.md +++ b/README_fr.md @@ -19,22 +19,42 @@ GoToSocial est un serveur de réseau social basé sur ActivityPub écrit en Gola ## Captures d'écran -![](./doc/screenshots/example.jpg) +![](./doc/screenshots/screenshot.jpg) ## Avertissements / informations importantes * Any known limitations, constrains or stuff not working, such as (but not limited to): - * requiring a full dedicated domain ? - * architectures not supported ? - * not-working single-sign on or LDAP integration ? - * the app requires an important amount of RAM / disk / .. to install or to work properly - * etc... + * GoToSocial require a dedicated root domain, eg. gotosocial.domain.tld + * This package is not-working single-sign on or LDAP integration + * This package is currently set to single-instance that means you can run a single GoToSocial instance on a single server. -* Other infos that people should be aware of, such as: - * any specific step to perform after installing (such as manually finishing the install, specific admin credentials, ...) - * how to configure / administrate the application if it ain't obvious - * upgrade process / specificities / things to be aware of ? - * security considerations ? +## Create and confirm your user + +You can use the GoToSocial binary to also create, confirm, and promote your user account. + +Run the following command to create a new account: + +```bash +./gotosocial --config-path ./config.yaml admin account create --username some_username --email some_email@whatever.org --password SOME_PASSWORD +``` + +In the above command, replace `some_username` with your desired username, `some_email@whatever.org` with the email address you want to associate with your account, and `SOME_PASSWORD` with a secure password. + +Run the following command to confirm the account you just created: + +```bash +./gotosocial --config-path ./config.yaml admin account confirm --username some_username +``` + +Replace `some_username` with the username of the account you just created. + +If you want your user to have admin rights, you can promote them using a similar command: + +```bash +./gotosocial --config-path ./config.yaml admin account promote --username some_username +``` + +Replace `some_username` with the username of the account you just created. ## Documentations et ressources