Move instance CLI task docs to a text file
This commit is contained in:
parent
a54739a530
commit
6435ba83cd
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
Every command should be ran with a prefix, in case of OTP releases it is `./bin/pleroma_ctl emoji` and in case of source installs it's `mix pleroma.emoji`.
|
Every command should be ran with a prefix, in case of OTP releases it is `./bin/pleroma_ctl emoji` and in case of source installs it's `mix pleroma.emoji`.
|
||||||
|
|
||||||
## Lists the emoji packs and metadata specified in the manifest.
|
## Lists emoji packs and metadata specified in the manifest
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
$PREFIX ls-packs [<options>]
|
$PREFIX ls-packs [<options>]
|
||||||
|
30
docs/administration/CLI_tasks/instance.md
Normal file
30
docs/administration/CLI_tasks/instance.md
Normal file
@ -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
|
@ -7,36 +7,6 @@ defmodule Mix.Tasks.Pleroma.Instance do
|
|||||||
import Mix.Pleroma
|
import Mix.Pleroma
|
||||||
|
|
||||||
@shortdoc "Manages Pleroma instance"
|
@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
|
|
||||||
"""
|
|
||||||
|
|
||||||
def run(["gen" | rest]) do
|
def run(["gen" | rest]) do
|
||||||
{options, [], []} =
|
{options, [], []} =
|
||||||
|
Loading…
Reference in New Issue
Block a user