From 6435ba83cd07162a9ad9a386253814e2f12d951d Mon Sep 17 00:00:00 2001
From: rinpatch <rinpatch@sdf.org>
Date: Thu, 3 Oct 2019 09:02:48 +0300
Subject: Move instance CLI task docs to a text file

---
 docs/administration/CLI_tasks/instance.md | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)
 create mode 100644 docs/administration/CLI_tasks/instance.md

(limited to 'docs/administration/CLI_tasks/instance.md')

diff --git a/docs/administration/CLI_tasks/instance.md b/docs/administration/CLI_tasks/instance.md
new file mode 100644
index 000000000..975ee61d9
--- /dev/null
+++ b/docs/administration/CLI_tasks/instance.md
@@ -0,0 +1,30 @@
+# Managing instance configuration
+
+Every command should be ran with a prefix, in case of OTP releases it is `./bin/pleroma_ctl instance` and in case of source installs it's `mix pleroma.instance`.
+
+## Generate a new configuration file
+```sh
+$PREFIX gen [<options>]
+```
+
+If any of the options are left unspecified, you will be prompted interactively.
+
+## Options
+- `-f`, `--force` - overwrite any output files
+- `-o <path>`, `--output <path>` - the output file for the generated configuration
+- `--output-psql <path>` - the output file for the generated PostgreSQL setup
+- `--domain <domain>` - the domain of your instance
+- `--instance-name <instance_name>` - the name of your instance
+- `--admin-email <email>` - the email address of the instance admin
+- `--notify-email <email>` - email address for notifications
+- `--dbhost <hostname>` - the hostname of the PostgreSQL database to use
+- `--dbname <database_name>` - the name of the database to use
+- `--dbuser <username>` - the user (aka role) to use for the database connection
+- `--dbpass <password>` - the password to use for the database connection
+- `--rum <Y|N>` - Whether to enable RUM indexes
+- `--indexable <Y|N>` - Allow/disallow indexing site by search engines
+- `--db-configurable <Y|N>` - Allow/disallow configuring instance from admin part
+- `--uploads-dir <path>` - the directory uploads go in when using a local uploader
+- `--static-dir <path>` - the directory custom public files should be read from (custom emojis, frontend bundle overrides, robots.txt, etc.)
+- `--listen-ip <ip>` - the ip the app should listen to, defaults to 127.0.0.1
+- `--listen-port <port>` - the port the app should listen to, defaults to 4000
-- 
cgit v1.2.3


From f5372bfb4a65c8324926965fe34c920bc2449bc5 Mon Sep 17 00:00:00 2001
From: rinpatch <rinpatch@sdf.org>
Date: Thu, 3 Oct 2019 09:36:35 +0300
Subject: Fix up some headings

---
 docs/administration/CLI_tasks/instance.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'docs/administration/CLI_tasks/instance.md')

diff --git a/docs/administration/CLI_tasks/instance.md b/docs/administration/CLI_tasks/instance.md
index 975ee61d9..ab0b68ad0 100644
--- a/docs/administration/CLI_tasks/instance.md
+++ b/docs/administration/CLI_tasks/instance.md
@@ -9,7 +9,7 @@ $PREFIX gen [<options>]
 
 If any of the options are left unspecified, you will be prompted interactively.
 
-## Options
+### Options
 - `-f`, `--force` - overwrite any output files
 - `-o <path>`, `--output <path>` - the output file for the generated configuration
 - `--output-psql <path>` - the output file for the generated PostgreSQL setup
-- 
cgit v1.2.3