diff options
author | Chocobozzz <me@florianbigard.com> | 2018-03-05 10:00:15 +0100 |
---|---|---|
committer | Chocobozzz <me@florianbigard.com> | 2018-03-05 10:00:15 +0100 |
commit | 358770dbbd88136b211090832b24cf3d5b648234 (patch) | |
tree | d02ead83bf3ad24bacf64664603da2cc25ac46c4 /support/doc | |
parent | ad34cfc8ac6ad537265c0e24daf30ee7cacd8e06 (diff) | |
download | PeerTube-358770dbbd88136b211090832b24cf3d5b648234.tar.gz PeerTube-358770dbbd88136b211090832b24cf3d5b648234.tar.zst PeerTube-358770dbbd88136b211090832b24cf3d5b648234.zip |
Refractor tools documentation
Diffstat (limited to 'support/doc')
-rw-r--r-- | support/doc/tools.md (renamed from support/doc/import-videos.md) | 27 | ||||
-rw-r--r-- | support/doc/upload-cli.md | 16 |
2 files changed, 19 insertions, 24 deletions
diff --git a/support/doc/import-videos.md b/support/doc/tools.md index 4e495d8df..4e431b3d4 100644 --- a/support/doc/import-videos.md +++ b/support/doc/tools.md | |||
@@ -1,21 +1,20 @@ | |||
1 | # Import videos guide | 1 | # CLI tools guide |
2 | |||
3 | You can use this script to import videos from all [supported sites of youtube-dl](https://rg3.github.io/youtube-dl/supportedsites.html) into PeerTube. | ||
4 | Be sure you own the videos or have the author's authorization to do so. | ||
5 | 2 | ||
6 | - [Installation](#installation) | 3 | - [Installation](#installation) |
7 | - [Usage](#usage) | 4 | - [Usage](#usage) |
5 | - [import-videos.js](#import-videos.js) | ||
6 | - [upload.js](#upload) | ||
8 | 7 | ||
9 | ## Installation | 8 | ## Installation |
10 | 9 | ||
11 | ## Prerequisites | 10 | ## Prerequisites |
12 | 11 | ||
13 | You need at least 512MB RAM to run the script. | 12 | You need at least 512MB RAM to run the script. |
14 | Importation can be launched directly from a PeerTube server (in this case you already have dependencies installed :+1:) or from a separate server, even a dekstop PC. | 13 | Scripts can be launched directly from a PeerTube server (in this case you already have dependencies installed :+1:) or from a separate server, even a dekstop PC. |
15 | 14 | ||
16 | ### Dependencies | 15 | ### Dependencies |
17 | 16 | ||
18 | * [PeerTube dependencies](dependencies.md) | 17 | Install the [PeerTube dependencies](dependencies.md). |
19 | 18 | ||
20 | ### Installation | 19 | ### Installation |
21 | 20 | ||
@@ -38,10 +37,13 @@ cd ${CLONE} | |||
38 | npm run build:server | 37 | npm run build:server |
39 | ``` | 38 | ``` |
40 | 39 | ||
40 | ## Tools | ||
41 | 41 | ||
42 | ## Usage | 42 | ### import-videos.js |
43 | |||
44 | You can use this script to import videos from all [supported sites of youtube-dl](https://rg3.github.io/youtube-dl/supportedsites.html) into PeerTube. | ||
45 | Be sure you own the videos or have the author's authorization to do so. | ||
43 | 46 | ||
44 | You are now ready to run the script : | ||
45 | 47 | ||
46 | ``` | 48 | ``` |
47 | cd ${CLONE} | 49 | cd ${CLONE} |
@@ -61,3 +63,12 @@ node dist/server/tools/import-videos.js -u "PEERTUBE_URL" -U "PEERTUBE_USER" --p | |||
61 | 63 | ||
62 | The script will get all public videos from Youtube, download them and upload to PeerTube. | 64 | The script will get all public videos from Youtube, download them and upload to PeerTube. |
63 | Already downloaded videos will not be uploaded twice, so you can run and re-run the script in case of crash, disconnection... | 65 | Already downloaded videos will not be uploaded twice, so you can run and re-run the script in case of crash, disconnection... |
66 | |||
67 | ### upload.js | ||
68 | |||
69 | You can use this script to import videos directly from the CLI. | ||
70 | |||
71 | ``` | ||
72 | cd ${CLONE} | ||
73 | node dist/server/tools/upload.js --help | ||
74 | ``` | ||
diff --git a/support/doc/upload-cli.md b/support/doc/upload-cli.md deleted file mode 100644 index 1eff1f0af..000000000 --- a/support/doc/upload-cli.md +++ /dev/null | |||
@@ -1,16 +0,0 @@ | |||
1 | # Upload videos from CLI | ||
2 | |||
3 | - [Installation](#installation) | ||
4 | - [Usage](#usage) | ||
5 | |||
6 | ## Installation | ||
7 | |||
8 | ### Dependencies | ||
9 | |||
10 | * [PeerTube dependencies](dependencies.md) | ||
11 | |||
12 | ## Usage | ||
13 | |||
14 | ``` | ||
15 | node dist/server/tools/upload.js --help | ||
16 | ``` | ||