From 358770dbbd88136b211090832b24cf3d5b648234 Mon Sep 17 00:00:00 2001 From: Chocobozzz Date: Mon, 5 Mar 2018 10:00:15 +0100 Subject: [PATCH] Refractor tools documentation --- README.md | 4 ++-- support/doc/{import-videos.md => tools.md} | 27 +++++++++++++++------- support/doc/upload-cli.md | 16 ------------- 3 files changed, 21 insertions(+), 26 deletions(-) rename support/doc/{import-videos.md => tools.md} (77%) delete mode 100644 support/doc/upload-cli.md diff --git a/README.md b/README.md index c15f838fc..efe94b15a 100644 --- a/README.md +++ b/README.md @@ -165,8 +165,8 @@ For now only on Github: ## Tools - * [Import videos (YouTube, Dailymotion, Vimeo...)](/support/doc/import-videos.md) - * [Upload videos from the CLI](/support/doc/upload-cli.md) + * [Import videos (YouTube, Dailymotion, Vimeo...)](/support/doc/tools.md) + * [Upload videos from the CLI](/support/doc/tools.md) ## Architecture diff --git a/support/doc/import-videos.md b/support/doc/tools.md similarity index 77% rename from support/doc/import-videos.md rename to support/doc/tools.md index 4e495d8df..4e431b3d4 100644 --- a/support/doc/import-videos.md +++ b/support/doc/tools.md @@ -1,21 +1,20 @@ -# Import videos guide - -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. -Be sure you own the videos or have the author's authorization to do so. +# CLI tools guide - [Installation](#installation) - [Usage](#usage) + - [import-videos.js](#import-videos.js) + - [upload.js](#upload) ## Installation ## Prerequisites You need at least 512MB RAM to run the script. -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. +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. ### Dependencies - * [PeerTube dependencies](dependencies.md) +Install the [PeerTube dependencies](dependencies.md). ### Installation @@ -38,10 +37,13 @@ cd ${CLONE} npm run build:server ``` +## Tools -## Usage +### import-videos.js + +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. +Be sure you own the videos or have the author's authorization to do so. -You are now ready to run the script : ``` cd ${CLONE} @@ -61,3 +63,12 @@ node dist/server/tools/import-videos.js -u "PEERTUBE_URL" -U "PEERTUBE_USER" --p The script will get all public videos from Youtube, download them and upload to PeerTube. Already downloaded videos will not be uploaded twice, so you can run and re-run the script in case of crash, disconnection... + +### upload.js + +You can use this script to import videos directly from the CLI. + +``` +cd ${CLONE} +node dist/server/tools/upload.js --help +``` 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 @@ -# Upload videos from CLI - - - [Installation](#installation) - - [Usage](#usage) - -## Installation - -### Dependencies - - * [PeerTube dependencies](dependencies.md) - -## Usage - -``` -node dist/server/tools/upload.js --help -```