Update README.md

This commit is contained in:
Yun
2022-03-05 11:48:41 +01:00
committed by GitHub
parent daf4d74a39
commit 053bb884d4

View File

@@ -41,11 +41,11 @@ Future releases will have:
- Format selection *in-progess* - Format selection *in-progess*
## Troubleshooting ## Troubleshooting
- It says that it isn't connected/ip in the footer is not defined. - **It says that it isn't connected/ip in the footer is not defined.**
- You must set the server ip address in the settings section (gear icon). - You must set the server ip address in the settings section (gear icon).
- The download doens't start. - **The download doens't start.**
- As before server address is not specified or simply yt-dlp process takes a lot of time to fire up. (Forking yt-dlp isn't fast especially if you have a lower-end/low-power NAS/server/desktop where the server is running) - As before server address is not specified or simply yt-dlp process takes a lot of time to fire up. (Forking yt-dlp isn't fast especially if you have a lower-end/low-power NAS/server/desktop where the server is running)
- Background jobs are not retrieved. - **Background jobs are not retrieved.**
- As before forking yt-dlp isn't fast so resuming _n_ background jobs takes _n_*_time to exec yt-dlp_ Just have patience. - As before forking yt-dlp isn't fast so resuming _n_ background jobs takes _n_*_time to exec yt-dlp_ Just have patience.
## Docker installation ## Docker installation
@@ -75,16 +75,16 @@ node dist/main.js
``` ```
## FAQ ## FAQ
- Will it availabe for Raspberry Pi/ generic ARM devices? - **Will it availabe for Raspberry Pi/ generic ARM devices?**
- Yes, absolutely a multi-arch docker image is planned to be released. - Yes, absolutely a multi-arch docker image is planned to be released.
Alternatively use the **non-docker / Manual** installation method. Alternatively use the **non-docker / Manual** installation method.
If you plan to use it on a Raspberry Pi ensure to have fast and durable storage. If you plan to use it on a Raspberry Pi ensure to have fast and durable storage.
- Why the docker image is so heavy? - **Why the docker image is so heavy?**
- Originally it was 1.8GB circa, now it has been slimmed to ~340MB compressed. This is due to the fact that it encapsule a basic Alpine linux image + FFmpeg + Node.js + Python3 + yt-dlp. - Originally it was 1.8GB circa, now it has been slimmed to ~340MB compressed. This is due to the fact that it encapsule a basic Alpine linux image + FFmpeg + Node.js + Python3 + yt-dlp.
- Am I forced to run it on port 3022? - **Am I forced to run it on port 3022?**
- Well, yes (until now). - Well, yes (until now).
## Todo list ## Todo list
- ~~retrieve background tasks~~ - ~~retrieve background tasks~~
- format selection - format selection
- better ui/ux - better ui/ux