X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=support%2Fdoc%2Ftools.md;h=ba6e2b12dd7e293b9d901d4d84b0a4fc23025b20;hb=675a8fc74faefa0161b0754bd61c710de7a449c5;hp=4f806a9db5834c029fcecf793f0fc183addf3524;hpb=7089e7b4e570710acac408bf95c688932a491707;p=github%2FChocobozzz%2FPeerTube.git diff --git a/support/doc/tools.md b/support/doc/tools.md index 4f806a9db..ba6e2b12d 100644 --- a/support/doc/tools.md +++ b/support/doc/tools.md @@ -18,6 +18,7 @@ - [prune-storage.js](#prune-storagejs) - [optimize-old-videos.js](#optimize-old-videosjs) - [update-host.js](#update-hostjs) + - [reset-password.js](#reset-passwordjs) - [REPL (Read Eval Print Loop)](#repl-read-eval-print-loop) - [.help](#help) - [Lodash example](#lodash-example) @@ -34,7 +35,8 @@ You need to follow all the following steps even if you are on a PeerTube server ### Dependencies -Install the [PeerTube dependencies](dependencies.md). +Install the [PeerTube dependencies](dependencies.md) except PostgreSQL and Redis. +PeerTube only supports NodeJS 8.x or 10.x. ### Installation @@ -43,23 +45,20 @@ Clone the PeerTube repo to get the latest version (even if you are on your PeerT ``` $ git clone https://github.com/Chocobozzz/PeerTube.git $ CLONE="$(pwd)/PeerTube" -``` - -Run ``yarn install --pure-lockfile`` -``` $ cd ${CLONE} -$ yarn install --pure-lockfile ``` -Build server tools: +Install dependencies and build CLI tools: + ``` -$ cd ${CLONE} -$ npm run build:server +$ NOCLIENT=1 yarn install --pure-lockfile +$ npm run setup:cli ``` ### CLI wrapper -The wrapper provides a convenient interface to the following scripts. You can access it as `peertube` via an alias in your `.bashrc` like `alias peertube="node /your/peertube/directory/dist/server/tools/peertube.js"`: +The wrapper provides a convenient interface to the following scripts. +You can access it as `peertube` via an alias in your `.bashrc` like `alias peertube="cd /your/peertube/directory/ && node ./dist/server/tools/peertube.js"` (you have to keep the `cd` command): ``` Usage: peertube [command] [options] @@ -118,7 +117,7 @@ $ node dist/server/tools/peertube-import-videos.js \ * `PEERTUBE_URL` : the full URL of your PeerTube server where you want to import, eg: https://peertube.cpy.re * `PEERTUBE_USER` : your PeerTube account where videos will be uploaded -* `PEERTUBE_PASSWORD` : password of your PeerTube account (if `PEERTUBE_PASSWORD` is omitted, you will be prompted for it) +* `PEERTUBE_PASSWORD` : password of your PeerTube account (if `--password PEERTUBE_PASSWORD` is omitted, you will be prompted for it) * `TARGET_URL` : the target url you want to import. Examples: * YouTube: * Channel: https://www.youtube.com/channel/ChannelId @@ -226,6 +225,14 @@ to run: $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run update-host ``` +### reset-password.js + +To reset a user password from CLI, run: + +``` +$ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run reset-password -- -u target_username +``` + ### REPL ([Read Eval Print Loop](https://nodejs.org/docs/latest-v8.x/api/repl.html)) If you want to interact with the application libraries and objects even when PeerTube is not running, there is a REPL for that.