Additional clarifications to README
This commit is contained in:
parent
53f7750e0d
commit
200c7d6d8c
1 changed files with 24 additions and 5 deletions
29
README.md
29
README.md
|
|
@ -47,11 +47,19 @@ Step. 1. You have two options
|
||||||
Already included in the `docker-compose.yml` file witht his project.
|
Already included in the `docker-compose.yml` file witht his project.
|
||||||
|
|
||||||
Step 2. Run — replace `/your/video/path` with the real path on your host
|
Step 2. Run — replace `/your/video/path` with the real path on your host
|
||||||
|
|
||||||
A. Using `docker run`:
|
If you want to persist data between updates, changes, etc.; then you need to create a "data" directory in the same location you store your 'docker-compose.yml' file.
|
||||||
|
|
||||||
`mkdir -p data`
|
`mkdir -p data`
|
||||||
|
|
||||||
|
Ensure the 'data' directory is accessible with permissions = 775.
|
||||||
|
|
||||||
|
`chmod -R 775 ./data`
|
||||||
|
|
||||||
|
A. Using `docker run`:
|
||||||
|
|
||||||
|
- with an image you build:
|
||||||
|
|
||||||
```
|
```
|
||||||
docker run -d \
|
docker run -d \
|
||||||
--name videopress \
|
--name videopress \
|
||||||
|
|
@ -61,9 +69,20 @@ docker run -d \
|
||||||
-v ./data:/data \
|
-v ./data:/data \
|
||||||
videopress
|
videopress
|
||||||
```
|
```
|
||||||
B. Using Docker Compose
|
|
||||||
|
|
||||||
`mkdir -p data`
|
- with the pre-built image:
|
||||||
|
|
||||||
|
```
|
||||||
|
docker run -d \
|
||||||
|
--name videopress \
|
||||||
|
--restart unless-stopped \
|
||||||
|
-p 8080:8080 \
|
||||||
|
-v /your/video/path:/media \
|
||||||
|
-v ./data:/data \
|
||||||
|
bmcgonag/videopress:latest
|
||||||
|
```
|
||||||
|
|
||||||
|
B. Using Docker Compose
|
||||||
|
|
||||||
`docker compose up -d`
|
`docker compose up -d`
|
||||||
|
|
||||||
|
|
@ -107,7 +126,7 @@ MEDIA_ROOT=/your/video/path ./start.sh --prod 9000
|
||||||
Every API call that accepts a path validates it with `safe_path()` before any
|
Every API call that accepts a path validates it with `safe_path()` before any
|
||||||
OS operation. `safe_path()` resolves symlinks and asserts the result is inside
|
OS operation. `safe_path()` resolves symlinks and asserts the result is inside
|
||||||
`MEDIA_ROOT`. Requests that attempt directory traversal are rejected with
|
`MEDIA_ROOT`. Requests that attempt directory traversal are rejected with
|
||||||
HTTP 403. The container runs as a non-root user (UID 1000).
|
HTTP 403. The container runs as a non-root user (e.g. your id. You can find this by entering the command `id` in the terminal, make note of the number for `uid` - usually 1000).
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue