diff options
| author | lain <lain@soykaf.club> | 2019-10-05 10:42:29 +0200 |
|---|---|---|
| committer | lain <lain@soykaf.club> | 2019-10-05 10:42:29 +0200 |
| commit | d9aaea44ff02d6a07d3be0f0675830eb51ac85ef (patch) | |
| tree | ce715c85f98875dd0ddf133f95a071fd40b91335 /lib/mix/tasks/pleroma/instance.ex | |
| parent | 8e83c8423fa846e82103b20798f0cbde676354ff (diff) | |
| parent | 9c47d8571c6c46503d9bb836aea933eda6e9e0a5 (diff) | |
| download | pleroma-d9aaea44ff02d6a07d3be0f0675830eb51ac85ef.tar.gz | |
Merge remote-tracking branch 'origin/develop' into reactions
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, [], []} = |