diff --git a/content/en/administration/post-installation.md b/content/en/administration/post-installation.md index 2d6285ea..44b8ac08 100644 --- a/content/en/administration/post-installation.md +++ b/content/en/administration/post-installation.md @@ -6,6 +6,21 @@ menu: weight: 3 --- +## Using the command-line interface + +The command-line interface of Mastodon is an executable file called `tootctl` residing in the `bin` directory within the Mastodon root directory. You must specify which environment you intend to use whenever you execute it by specifying the `RAILS_ENV` environment variable. Unless you are a developer working on a local machine, you need to use `RAILS_ENV=production`. If you are sure that you will never need another environment (for development, testing, or staging), you can add it to your `.bashrc` file for convenience, e.g.: + +```bash +echo "export RAILS_ENV=production" >> ~/.bashrc +``` + +If so, you won't need to specify it each time inline. Otherwise, calls to `tootctl` will usually go like this, assuming that the Mastodon code is checked out in `/home/mastodon/live`: + +```bash +cd /home/mastodon/live +RAILS_ENV=production bin/tootctl help +``` + ## Creating an admin account ### In the browser @@ -17,7 +32,7 @@ RAILS_ENV=production bin/tootctl accounts update alice --role admin ### From the command line -You can create a new account using the command line interface. +You can create a new account using the command-line interface. ```bash RAILS_ENV=production bin/tootctl accounts create \