SuperSeriousBusiness
/
GoToSocial
mirror of https://github.com/superseriousbusiness/gotosocial
1
1
Fork 0
Code Issues Projects Releases Wiki Activity

[docs] Fix documentation to show --config-path in the right position. (#375) 

The current position gets rejected as an unknown argument.
This commit is contained in:
Phil Hagelberg 2022-02-03 03:30:06 -08:00 committed by GitHub
parent aa34ff1bd9
commit 98341a1d4d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/admin/cli.md
View File

@ -31,7 +31,7 @@ Under `Available Commands`, you can see the standard `server` command. But there
**Please note -- for all of these commands, you will still need to set the global options correctly so that the CLI tool knows how eg., how to connect to your database, which database to use, which host and account domain to use etc.** **Please note -- for all of these commands, you will still need to set the global options correctly so that the CLI tool knows how eg., how to connect to your database, which database to use, which host and account domain to use etc.**
You can set these options using environment variables, passing them as CLI flags (eg., `gotosocial [commands] --host example.org`), or by just pointing the CLI tool towards your config file (eg., `gotosocial [commands] --config-path ./config.yaml`). You can set these options using environment variables, passing them as CLI flags (eg., `gotosocial [commands] --host example.org`), or by just pointing the CLI tool towards your config file (eg., `gotosocial --config-path ./config.yaml [commands]`).
## gotosocial admin ## gotosocial admin

2
docs/configuration/index.md
View File

@ -13,7 +13,7 @@ There are three different methods for configuring a GoToSocial instance, which c
The easiest way to configure GoToSocial is to pass a configuration file to to the `gotosocial server start` command, for example: The easiest way to configure GoToSocial is to pass a configuration file to to the `gotosocial server start` command, for example:
```bash ```bash
gotosocial server start --config-path ./config.yaml gotosocial --config-path ./config.yaml server start
``` ```
The command expects a file in [YAML](https://en.wikipedia.org/wiki/YAML) or [JSON](https://en.wikipedia.org/wiki/JSON) format. The command expects a file in [YAML](https://en.wikipedia.org/wiki/YAML) or [JSON](https://en.wikipedia.org/wiki/JSON) format.

6
docs/installation_guide/binary.md
View File

@ -77,7 +77,7 @@ You can use the GoToSocial binary to also create, confirm, and promote your user
Run the following command to create a new account: Run the following command to create a new account:
```bash ```bash
./gotosocial admin account create --config-path ./config.yaml --username some_username --email some_email@whatever.org --password SOME_PASSWORD ./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. 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.
@ -85,7 +85,7 @@ In the above command, replace `some_username` with your desired username, `some_
Run the following command to confirm the account you just created: Run the following command to confirm the account you just created:
```bash ```bash
./gotosocial admin account confirm --config-path ./config.yaml --username some_username ./gotosocial --config-path ./config.yaml admin account confirm --username some_username
``` ```
Replace `some_username` with the username of the account you just created. Replace `some_username` with the username of the account you just created.
@ -93,7 +93,7 @@ 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: If you want your user to have admin rights, you can promote them using a similar command:
```bash ```bash
./gotosocial admin account promote --config-path ./config.yaml --username some_username ./gotosocial --config-path ./config.yaml admin account promote --username some_username
``` ```
Replace `some_username` with the username of the account you just created. Replace `some_username` with the username of the account you just created.