Skip to content

Commit 6eb5975

Browse files
committedJul 4, 2024·
update readme, add stop scripts
1 parent 4e4c99d commit 6eb5975

File tree

3 files changed

+42
-5
lines changed

3 files changed

+42
-5
lines changed
 

‎README.md

+36-5
Original file line numberDiff line numberDiff line change
@@ -46,10 +46,15 @@ A web-based user interface for yt-dlp, allowing easy video downloads from YouTub
4646
4747
4. Open your web browser and navigate to `http://localhost:3000` to use the application.
4848
49-
5. To stop the application, run:
50-
```
51-
docker-compose down
52-
```
49+
5. To stop the application:
50+
- On Unix-based systems (Linux, macOS):
51+
```
52+
./stop.sh
53+
```
54+
- On Windows:
55+
```
56+
stop.bat
57+
```
5358
5459
5560
### Local Development Setup
@@ -99,16 +104,42 @@ A web-based user interface for yt-dlp, allowing easy video downloads from YouTub
99104
100105
4. Open your browser and navigate to `http://localhost:3000`
101106
107+
108+
## Use prebuilt docker images from github
109+
110+
To start
111+
112+
```bash
113+
docker-compose -f docker-compose.external.yml up -d
114+
```
115+
116+
To stop
117+
118+
```bash
119+
docker-compose -f docker-compose.external.yml down
120+
```
121+
122+
102123
## Usage
103124

104125
1. Enter the URL of the video you want to download in the input field.
105126
2. Select your preferred download options (format, quality, etc.).
106127
3. Click the "Download" button to start the download process.
107-
4. The downloaded files will be saved in the specified output directory of Downloads in the dockerfile if using native app then in Downloads of windows user.
128+
4. The downloaded files will be saved in the specified output directory of Downloads in the docker folder, if using native app then in Downloads folder of windows user.
108129

109130
## Docker Commands
110131

111132
- Start the containers: `docker-compose up -d`
112133
- Stop the containers: `docker-compose down`
113134
- View logs: `docker-compose logs`
114135
- Rebuild and start the containers: `docker-compose up -d --build`
136+
137+
138+
## Notes
139+
140+
I know the Downloads folder in the docker folder isn't ideal for most and might be changing but do to windows permission issues with docker trying to map to users downloads folder is an issue, there is work that can be done to allow it but trying to make this setup easy for most users. Hence the double click scripts to get up and going.
141+
142+
## Contributing
143+
144+
Contributions are welcome! Please feel free to submit a Pull Request.
145+

‎stop.bat

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
@echo off
2+
docker-compose -f docker-compose.external.yml down
3+
echo YT-DLP WebUI has been stopped.

‎stop.sh

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
#!/bin/bash
2+
docker-compose -f docker-compose.external.yml down
3+
echo "YT-DLP WebUI has been stopped."

0 commit comments

Comments
 (0)
Please sign in to comment.