Skip to content

Commit

Permalink
update readme, add stop scripts
Browse files Browse the repository at this point in the history
  • Loading branch information
bigsk1 committed Jul 4, 2024
1 parent 4e4c99d commit 6eb5975
Show file tree
Hide file tree
Showing 3 changed files with 42 additions and 5 deletions.
41 changes: 36 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,10 +46,15 @@ A web-based user interface for yt-dlp, allowing easy video downloads from YouTub

4. Open your web browser and navigate to `http://localhost:3000` to use the application.

5. To stop the application, run:
```
docker-compose down
```
5. To stop the application:
- On Unix-based systems (Linux, macOS):
```
./stop.sh
```
- On Windows:
```
stop.bat
```


### Local Development Setup
Expand Down Expand Up @@ -99,16 +104,42 @@ A web-based user interface for yt-dlp, allowing easy video downloads from YouTub

4. Open your browser and navigate to `http://localhost:3000`


## Use prebuilt docker images from github

To start

```bash
docker-compose -f docker-compose.external.yml up -d
```

To stop

```bash
docker-compose -f docker-compose.external.yml down
```


## Usage

1. Enter the URL of the video you want to download in the input field.
2. Select your preferred download options (format, quality, etc.).
3. Click the "Download" button to start the download process.
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.
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.

## Docker Commands

- Start the containers: `docker-compose up -d`
- Stop the containers: `docker-compose down`
- View logs: `docker-compose logs`
- Rebuild and start the containers: `docker-compose up -d --build`


## Notes

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.

## Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

3 changes: 3 additions & 0 deletions stop.bat
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
@echo off
docker-compose -f docker-compose.external.yml down
echo YT-DLP WebUI has been stopped.
3 changes: 3 additions & 0 deletions stop.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
#!/bin/bash
docker-compose -f docker-compose.external.yml down
echo "YT-DLP WebUI has been stopped."

0 comments on commit 6eb5975

Please sign in to comment.