Add redundancy CLI doc

pull/2438/head
Chocobozzz 2020-01-28 13:57:04 +01:00
parent 144c6559ed
commit e669ff5873
No known key found for this signature in database
GPG Key ID: 583A612D890159BE
2 changed files with 37 additions and 1 deletions

View 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 () {

View 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.