diff --git a/docs/docker.md b/docs/docker.md index 2b10a82..97b7f1a 100644 --- a/docs/docker.md +++ b/docs/docker.md @@ -2,17 +2,15 @@ If you prefer hosting without Docker, see [Self-Hosting](selfhost.md) instead. -Docker Engine and Docker Compose are required. - -Note that built images are not provided via Docker Hub. -If you can't or don't want to build them on your server -and don't want to setup a CI/CD system, -[let us know](https://github.com/txtdot/txtdot/issues), -we'll consider setting up a GitHub Actions workflow. - +Download docker-compose.yml and txtdot configs, +edit them and then start the container: ```bash -git clone https://github.com/txtdot/txtdot.git -cd txtdot -docker compose build +wget https://raw.githubusercontent.com/TxtDot/txtdot/main/docker-compose.yml +wget -O .env https://raw.githubusercontent.com/TxtDot/txtdot/main/.env.example +nano .env docker compose up -d ``` + +Alternatively, you can configure txtdot with +the `environment` section of docker-compose config +(don't forget to remove .env and `volumes`). diff --git a/docs/env.md b/docs/env.md index 0a3d4b5..4d92718 100644 --- a/docs/env.md +++ b/docs/env.md @@ -24,3 +24,16 @@ Default: `false` Set it to `true` only if your txtdot instance runs behind reverse proxy. Needed for processing X-Forwarded headers. + +## PROXY_RES + +Default: `true` + +Whether to allow proxying images, video, audio +and everything else through your txtdot instance. + +## SWAGGER + +Default: `false` + +Whether to add `/doc` route for Swagger API docs.