Wavyzz/lbc-finder
2
0
Fork 0
mirror of https://github.com/etienne-hd/lbc-finder.git synced 2026-05-01 13:15:35 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs(README): support of optional requirements.txt in Docker section

Browse Source
This commit is contained in:
etienne-hd
2026-03-07 16:53:43 +01:00
parent 31682fabbf
commit d48349b271
1 changed files with 26 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
README.md
View File

@@ -73,7 +73,7 @@ The easiest way is to use the prebuilt image from Docker Hub:
```bash ```bash
docker pull etiennehode/lbc-finder:latest docker pull etiennehode/lbc-finder:latest
``` ````
### Build locally ### Build locally
@@ -89,29 +89,44 @@ docker build -t lbc-finder .
docker run -d \ docker run -d \
--name lbc-finder \ --name lbc-finder \
-v lbc_data:/app/data \ -v lbc_data:/app/data \
-v $(pwd)/config.py:/app/config.py \ -v $(pwd)/config:/app/config \
etiennehode/lbc-finder:latest etiennehode/lbc-finder:latest
``` ```
### Volumes ### Volumes
Two volumes are used: | Path in container | Description |
| ----------------- | --------------------------------------------------------------------------------------------------- |
| Volume | Description | | `/app/config` | Your search configuration files **and optional `requirements.txt`** for additional Python libraries |
| ---------------- | ----------------------------------- | | `/app/data` | Persistent storage for detected ads |
| `/app/config.py` | Your search configuration file |
| `/app/data` | Persistent storage for detected ads |
Example: Example:
```bash ```bash
-v $(pwd)/config.py:/app/config.py -v $(pwd)/config:/app/config
``` ```
This mounts your local `config.py` file into the container so you can easily edit your searches without rebuilding the image. This mounts your local `config/` folder into the container so you can easily edit your searches.
> **Extra Python libraries:**
> If your configuration requires additional Python packages, create a `requirements.txt` file inside your `config/` folder.
> The container startup script will automatically install all listed packages before running **lbc-finder**:
```sh
#!/bin/sh
if [ -e config/requirements.txt ]
then
pip install --no-cache-dir -r config/requirements.txt
fi
exec "$@"
```
This way, you can extend the container with any Python library you need without modifying the Docker image itself.
## Configuration ## Configuration
A [config.py](config.py) file is provided by default in the project, it contains a basic configuration. A [config](lbc-finder/config/__init__.py) file is provided by default in the project, it contains a basic configuration.
Inside this file, you must define a `CONFIG` variable, which is an list of `Search` objects. Inside this file, you must define a `CONFIG` variable, which is an list of `Search` objects.