Move uploads task docs to a separate file
authorrinpatch <rinpatch@sdf.org>
Thu, 3 Oct 2019 06:35:21 +0000 (09:35 +0300)
committerrinpatch <rinpatch@sdf.org>
Thu, 3 Oct 2019 06:35:21 +0000 (09:35 +0300)
docs/administration/CLI_tasks/uploads.md [new file with mode: 0644]
lib/mix/tasks/pleroma/uploads.ex

diff --git a/docs/administration/CLI_tasks/uploads.md b/docs/administration/CLI_tasks/uploads.md
new file mode 100644 (file)
index 0000000..a72bbd0
--- /dev/null
@@ -0,0 +1,12 @@
+# Managing uploads
+
+Every command should be ran with a prefix, in case of OTP releases it is `./bin/pleroma_ctl uploads` and in case of source installs it's `mix pleroma.uploads`.
+
+## Migrate uploads from local to remote storage
+```sh
+$PREFIX migrate_local TARGET_UPLOADER [OPTIONS...]
+```
+## Options
+- `--delete` - delete local uploads after migrating them to the target uploader
+
+A list of available uploaders can be seen in [Configuration Cheat Sheet](../../configuration/cheatsheet.md#pleromaupload)
index 95392d81b4ae0c4e6a8a63c12bb9313a89e92241..bc2248a76080981a818a992f9d0f6a193f11e5e8 100644 (file)
@@ -12,16 +12,7 @@ defmodule Mix.Tasks.Pleroma.Uploads do
   @log_every 50
 
   @shortdoc "Migrates uploads from local to remote storage"
-  @moduledoc """
-   Manages uploads
 
-   ## Migrate uploads from local to remote storage
-       mix pleroma.uploads migrate_local TARGET_UPLOADER [OPTIONS...]
-   Options:
-   - `--delete` - delete local uploads after migrating them to the target uploader
-
-   A list of available uploaders can be seen in config.exs
-  """
   def run(["migrate_local", target_uploader | args]) do
     delete? = Enum.member?(args, "--delete")
     start_pleroma()