diff options
author | rinpatch <rinpatch@sdf.org> | 2019-10-03 15:43:03 +0000 |
---|---|---|
committer | rinpatch <rinpatch@sdf.org> | 2019-10-03 15:43:03 +0000 |
commit | 4fe2af3b2d6b0701de2ae88f9932e4b6039ced11 (patch) | |
tree | 95dfb9f82ee8a3259f0f8d1d6ce27cc562819fb6 /lib/mix/tasks/pleroma/instance.ex | |
parent | c5e937b156ea1f8f96ade7d9104fc2c5fd1dd9cd (diff) | |
parent | b2f2012a4f34cfe8151e62d045f0eab3d165791a (diff) | |
download | pleroma-4fe2af3b2d6b0701de2ae88f9932e4b6039ced11.tar.gz |
Merge branch 'mkdocs-migration-prep' into 'develop'
MkDocs migration preparation
See merge request pleroma/pleroma!1774
Diffstat (limited to 'lib/mix/tasks/pleroma/instance.ex')
-rw-r--r-- | lib/mix/tasks/pleroma/instance.ex | 31 |
1 files changed, 1 insertions, 30 deletions
diff --git a/lib/mix/tasks/pleroma/instance.ex b/lib/mix/tasks/pleroma/instance.ex index 1a1634fe9..9af6cda30 100644 --- a/lib/mix/tasks/pleroma/instance.ex +++ b/lib/mix/tasks/pleroma/instance.ex @@ -7,36 +7,7 @@ defmodule Mix.Tasks.Pleroma.Instance do import Mix.Pleroma @shortdoc "Manages Pleroma instance" - @moduledoc """ - Manages Pleroma instance. - - ## Generate a new instance config. - - mix pleroma.instance gen [OPTION...] - - If any 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 ADMIN_EMAIL` - the email address of the instance admin - - `--notify-email NOTIFY_EMAIL` - email address for notifications - - `--dbhost HOSTNAME` - the hostname of the PostgreSQL database to use - - `--dbname DBNAME` - the name of the database to use - - `--dbuser DBUSER` - the user (aka role) to use for the database connection - - `--dbpass DBPASS` - 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` - the directory uploads go in when using a local uploader - - `--static-dir` - the directory custom public files should be read from (custom emojis, frontend bundle overrides, robots.txt, etc.) - - `--listen-ip` - the ip the app should listen to, defaults to 127.0.0.1 - - `--listen-port` - the port the app should listen to, defaults to 4000 - """ + @moduledoc File.read!("docs/administration/CLI_tasks/instance.md") def run(["gen" | rest]) do {options, [], []} = |