Updated Readme and refactoring

This commit is contained in:
2022-06-08 11:54:22 +02:00
parent aa95cd7abc
commit 323e2df0e4
2 changed files with 12 additions and 8 deletions

View File

@@ -35,6 +35,8 @@ Refactoring and JSDoc.
05/05/22: Material UI update 05/05/22: Material UI update
03/06/22: The most requested feature finally implemented: Format Selection!! 03/06/22: The most requested feature finally implemented: Format Selection!!
08/06/22: ARM builds
``` ```
@@ -74,7 +76,7 @@ Future releases will have:
- ~~Exctract audio~~ *done* - ~~Exctract audio~~ *done*
- ~~Format selection~~ *done* - ~~Format selection~~ *done*
- Download archive - Download archive
- ARM Build - ~~ARM Build~~ *done available through ghcr.io*
## 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.**
@@ -86,8 +88,8 @@ Future releases will have:
## Docker installation ## Docker installation
```shell ```shell
docker pull marcobaobao/yt-dlp-webui:latest docker pull marcobaobao/yt-dlp-webui:latest #x86 only
# or alternatively docker pull ghcr.io/marcobaobao/yt-dlp-web-ui:master # or alternatively for ARM and x86 devices docker pull ghcr.io/marcobaobao/yt-dlp-web-ui:master
docker run -d -p 3022:3022 -v <your dir>:/usr/src/yt-dlp-webui/downloads marcobaobao/yt-dlp-webui docker run -d -p 3022:3022 -v <your dir>:/usr/src/yt-dlp-webui/downloads marcobaobao/yt-dlp-webui
``` ```
or or
@@ -113,8 +115,10 @@ 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, it's currently available through ghcr.io
Alternatively use the **non-docker / Manual** installation method. ```
docker pull ghcr.io/marcopeocchi/yt-dlp-web-ui:master
```
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.

View File

@@ -95,7 +95,7 @@ export default function Settings({ socket }: Props) {
</Typography> </Typography>
<FormGroup> <FormGroup>
<Grid container spacing={2}> <Grid container spacing={2}>
<Grid item xs={12} md={10}> <Grid item xs={12} md={12}>
<TextField <TextField
fullWidth fullWidth
label={settings.i18n.t('serverAddressTitle')} label={settings.i18n.t('serverAddressTitle')}
@@ -108,7 +108,7 @@ export default function Settings({ socket }: Props) {
sx={{ mb: 2 }} sx={{ mb: 2 }}
/> />
</Grid> </Grid>
<Grid item xs={12} md={2}> {/* <Grid item xs={12} md={2}>
<TextField <TextField
fullWidth fullWidth
label={settings.i18n.t('serverAddressTitle')} label={settings.i18n.t('serverAddressTitle')}
@@ -117,7 +117,7 @@ export default function Settings({ socket }: Props) {
error={invalidIP} error={invalidIP}
sx={{ mb: 2 }} sx={{ mb: 2 }}
/> />
</Grid> </Grid> */}
</Grid> </Grid>
<Grid container spacing={2}> <Grid container spacing={2}>
<Grid item xs={12} md={6}> <Grid item xs={12} md={6}>