feat(UI): added docker image and config
This commit is contained in:
@@ -47,6 +47,31 @@ If on Arch Linux or derivative operating systems such as Manjaro, the BDFR can b
|
||||
|
||||
If you want to use the source code or make contributions, refer to [CONTRIBUTING](docs/CONTRIBUTING.md#preparing-the-environment-for-development)
|
||||
|
||||
### Docker Deployment
|
||||
|
||||
The BDFR Web Interface provides a complete Docker setup with both the CLI tool and web interface. This is the easiest way to get started:
|
||||
|
||||
**Quick Start (Linux/Mac):**
|
||||
```bash
|
||||
chmod +x docker-quick-start.sh
|
||||
./docker-quick-start.sh
|
||||
```
|
||||
|
||||
**Quick Start (Windows):**
|
||||
```cmd
|
||||
docker-quick-start.bat
|
||||
```
|
||||
|
||||
**Manual Start:**
|
||||
```bash
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
The web interface will be available at `http://localhost:8000`. All downloads are stored in the `./downloads` directory on your host machine.
|
||||
|
||||
For detailed Docker documentation, including configuration, volume management, and troubleshooting, see [DOCKER.md](DOCKER.md).
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
The BDFR works by taking submissions from a variety of "sources" from Reddit and then parsing them to download. These sources might be a subreddit, multireddit, a user list, or individual links. These sources are combined and downloaded to disk, according to a naming and organisational scheme defined by the user.
|
||||
|
||||
Reference in New Issue
Block a user