aboutsummaryrefslogtreecommitdiff
path: root/docs/administration/CLI_tasks
diff options
context:
space:
mode:
authorMaksim Pechnikov <parallel588@gmail.com>2019-12-05 12:22:19 +0300
committerMaksim Pechnikov <parallel588@gmail.com>2019-12-05 12:22:19 +0300
commit49bb0a130f93476d32d3177d7a989b7a98a063f2 (patch)
tree6e64e2bbe2644dd607ec685de5b2bf94c1f9326c /docs/administration/CLI_tasks
parentb9041c209787dc279d4dc5194d65dff73684cdb9 (diff)
parent228bf4d214abe3bb62c52128d3bc145e396b174d (diff)
downloadpleroma-49bb0a130f93476d32d3177d7a989b7a98a063f2.tar.gz
Merge branch 'develop' into issue/1276
Diffstat (limited to 'docs/administration/CLI_tasks')
-rw-r--r--docs/administration/CLI_tasks/database.md3
-rw-r--r--docs/administration/CLI_tasks/user.md5
2 files changed, 8 insertions, 0 deletions
diff --git a/docs/administration/CLI_tasks/database.md b/docs/administration/CLI_tasks/database.md
index 484639231..3011646c8 100644
--- a/docs/administration/CLI_tasks/database.md
+++ b/docs/administration/CLI_tasks/database.md
@@ -2,6 +2,9 @@
Every command should be ran with a prefix, in case of OTP releases it is `./bin/pleroma_ctl database` and in case of source installs it's `mix pleroma.database`.
+!!! danger
+ These mix tasks can take a long time to complete. Many of them were written to address specific database issues that happened because of bugs in migrations or other specific scenarios. Do not run these tasks "just in case" if everything is fine your instance.
+
## Replace embedded objects with their references
Replaces embedded objects with references to them in the `objects` table. Only needs to be ran once if the instance was created before Pleroma 1.0.5. The reason why this is not a migration is because it could significantly increase the database size after being ran, however after this `VACUUM FULL` will be able to reclaim about 20% (really depends on what is in the database, your mileage may vary) of the db size before the migration.
diff --git a/docs/administration/CLI_tasks/user.md b/docs/administration/CLI_tasks/user.md
index cf120f2c9..96b2d9e6a 100644
--- a/docs/administration/CLI_tasks/user.md
+++ b/docs/administration/CLI_tasks/user.md
@@ -15,6 +15,11 @@ $PREFIX new <nickname> <email> [<options>]
- `--admin`/`--no-admin` - whether the user should be an admin
- `-y`, `--assume-yes`/`--no-assume-yes` - whether to assume yes to all questions
+## List local users
+```sh
+$PREFIX list
+```
+
## Generate an invite link
```sh
$PREFIX invite [<options>]