From 98341a1d4d18b27445f21c5c7aa51f26ac55b653 Mon Sep 17 00:00:00 2001 From: Phil Hagelberg Date: Thu, 3 Feb 2022 03:30:06 -0800 Subject: [PATCH] [docs] Fix documentation to show --config-path in the right position. (#375) The current position gets rejected as an unknown argument. --- docs/admin/cli.md | 2 +- docs/configuration/index.md | 2 +- docs/installation_guide/binary.md | 6 +++--- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/admin/cli.md b/docs/admin/cli.md index a65282ce..7a71f2fc 100644 --- a/docs/admin/cli.md +++ b/docs/admin/cli.md @@ -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.** -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 diff --git a/docs/configuration/index.md b/docs/configuration/index.md index ed36505e..5aa10df9 100644 --- a/docs/configuration/index.md +++ b/docs/configuration/index.md @@ -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: ```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. diff --git a/docs/installation_guide/binary.md b/docs/installation_guide/binary.md index 6faba115..173237da 100644 --- a/docs/installation_guide/binary.md +++ b/docs/installation_guide/binary.md @@ -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: ```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. @@ -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: ```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. @@ -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: ```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.