Add redundancy CLI doc
authorChocobozzz <me@florianbigard.com>
Tue, 28 Jan 2020 12:57:04 +0000 (13:57 +0100)
committerChocobozzz <me@florianbigard.com>
Tue, 28 Jan 2020 12:57:49 +0000 (13:57 +0100)
server/tests/cli/peertube.ts
support/doc/tools.md

index 09cbcdb6581e82026f15ea06387533f1b839b576..15b6755f22d1338622944afcd77fd3d5abc75f6c 100644 (file)
@@ -277,6 +277,12 @@ describe('Test CLI wrapper', function () {
         expect(stdout).to.not.contain('super video')
       }
     })
+
+    after(async function () {
+      this.timeout(10000)
+
+      await cleanupTests([ anotherServer ])
+    })
   })
 
   after(async function () {
index d5427b5b7a771dfeeee1bfb8f2224d9ddc7b7095..1f1e52c36dc58a68932f005fceb15255434c4e0d 100644 (file)
@@ -12,6 +12,7 @@
     - [peertube-upload.js](#peertube-uploadjs)
     - [peertube-watch.js](#peertube-watchjs)
     - [peertube-plugins.js](#peertube-pluginsjs)
+    - [peertube-redundancy.js](#peertube-redundancyjs)
 - [Server tools](#server-tools)
   - [parse-log](#parse-log)
   - [create-transcoding-job.js](#create-transcoding-jobjs)
@@ -77,7 +78,8 @@ You can access it as `peertube` via an alias in your `.bashrc` like `alias peert
     import-videos|import  import a video from a streaming platform
     watch|w               watch a video in the terminal ✩°。⋆
     repl                  initiate a REPL to access internals
-    plugins|p [action]    manag instance plugins
+    plugins|p [action]    manage instance plugins
+    redundancy|r [action] manage video redundancies
     help [cmd]            display help for [cmd]
 ```
 
@@ -200,6 +202,34 @@ $ node dist/server/tools/peertube-plugins.js install --path /my/plugin/path
 $ node dist/server/tools/peertube-plugins.js install --npm-name peertube-theme-example
 ```
 
+#### peertube-redundancy.js
+
+Manage (list/add/remove) video redundancies:
+
+To list your videos that are duplicated by remote instances:
+
+```
+$ node dist/server/tools/peertube.js redundancy list-remote-redundancies
+```
+
+To list remote videos that your instance duplicated:
+
+```
+$ node dist/server/tools/peertube.js redundancy list-my-redundancies
+```
+
+To duplicate a specific video in your redundancy system:
+
+```
+$ node dist/server/tools/peertube.js redundancy add --video 823
+```
+
+To remove a video redundancy:
+
+```
+$ node dist/server/tools/peertube.js redundancy remove --video 823
+```
+
 ## Server tools
 
 These scripts should be run on the server, in `peertube-latest` directory.