txtdot/documentation
2
0
Fork 0
mirror of https://github.com/TxtDot/documentation.git synced 2024-10-16 11:48:06 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #3 from TxtDot/upd2

Browse source 
Docs update: docker and .env
This commit is contained in:
Andrey 2023-09-25 13:02:18 +04:00 committed by GitHub
commit ea47bafb84
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 22 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
docs/docker.md
View file

@ -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`).

13
docs/env.md
View file

@ -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.