replace fs by fs-extra to prevent EMFILE error

[github/Chocobozzz/PeerTube.git] / support / doc / tools.md

diff --git a/support/doc/tools.md b/support/doc/tools.md
index 85ce0428d341349a962ca77915384842d855320c..2f36d07fdcc90d58d5dde0eebda24094f651b640 100644 (file)
--- a/support/doc/tools.md
+++ b/support/doc/tools.md
@@ -63,13 +63,18 @@ $ node dist/server/tools/import-videos.js \
   * Vimeo: https://vimeo.com/xxxxxx
   * Dailymotion: https://www.dailymotion.com/xxxxx
 
- 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...
+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...
+
+Videos will be publicly available after transcoding (you can see them before that in your account on the web interface).
+
 
 ### upload.js
 
 You can use this script to import videos directly from the CLI.
 
+Videos will be publicly available after transcoding (you can see them before that in your account on the web interface).
+
 ```
 $ cd ${CLONE}
 $ node dist/server/tools/upload.js --help
@@ -80,6 +85,16 @@ $ node dist/server/tools/upload.js --help
 
 These scripts should be run on the server, in `peertube-latest` directory.
 
+### parse-log
+
+To parse PeerTube last log file:
+
+```
+$ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run parse-log -- --level info
+```
+
+`--level` is optional and could be `info`/`warn`/`error`
+
 ### create-transcoding-job.js
 
 You can use this script to force transcoding of an existing video.
@@ -87,6 +102,11 @@ You can use this script to force transcoding of an existing video.
 ```
 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run create-transcoding-job -- -v [videoUUID]
 ```
+
+Or to transcode to a specific resolution:
+```
+$ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run create-transcoding-job -- -v [videoUUID] -r [resolution]
+```
    
 ### create-import-video-file-job.js
 
@@ -103,4 +123,13 @@ To delete them (a confirmation will be demanded first):
 
 ```
 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run prune-storage
+```
+
+### update-host.js
+
+If you started PeerTube with a domain, and then changed it you will have invalid torrent files and invalid URLs in your database.
+To fix this, you have to run:
+
+```
+$ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run update-host
 ```
\ No newline at end of file