homelab-blueprint/docker-compose-files/it-tools/README.md
Brian Pooe 1815beadf4 refactor: restructure docs, sync stacks with Caddyfile, harden compose templates
- Add compose stacks for apps already proxied by Caddy: bento-pdf,
  it-tools, paperless-ngx, and beszel-hub (with Makefile targets)
- Remove the unused Vault stack and the drawio Caddyfile block
- Fix Caddyfile gramps upstream to port 80 to match the compose file
- Bring immich and gramps-web up to the shared template pattern
  (no-new-privileges, log rotation, memory limits, healthchecks)
- Single-quote vaultwarden SSO_AUDIENCE_TRUSTED so regex values like
  ^\d{18}$ render as valid YAML
- Move root docs into kebab-case topic folders, rebuild the docs index
  to cover every doc, and fix all broken links
2026-07-03 17:45:16 +02:00

66 lines
1.5 KiB
Markdown

# IT-Tools
Collection of handy developer and sysadmin tools (encoders, converters, token
generators, network calculators) served as a static site. Everything runs
client-side in the browser.
## Persistent Data
None. The container is stateless; nothing needs backing up.
## Installation
1. Create `.env` if it does not exist:
```bash
cp -n .env.sample .env
```
2. Adjust the values in `.env` if needed:
```dotenv
TZ=Africa/Johannesburg
IT_TOOLS_PORT=80
IT_TOOLS_MEM_LIMIT=128m
DOCKERLOGGING_MAXFILE=3
DOCKERLOGGING_MAXSIZE=10m
```
3. Deploy with `make`:
```bash
make deploy-it-tools
```
Manual equivalent:
```bash
./substitute_env.sh docker-compose-files/it-tools/template.yaml docker-compose.it-tools.yml .env
docker compose -f docker-compose.it-tools.yml config --quiet
docker compose -f docker-compose.it-tools.yml up -d
```
4. Verify the container and open `http://<host-ip>`:
```bash
docker compose -f docker-compose.it-tools.yml ps
docker compose -f docker-compose.it-tools.yml logs --tail=100 it-tools
```
## Reverse Proxy
The Caddyfile proxies `it-tools.<domain>` to this host on port 80. After
changing the port, update `docker-compose-files/caddy/Caddyfile_template` and
run `make reload-caddy`.
## Useful Commands
```bash
# Tail logs
docker compose -f docker-compose.it-tools.yml logs -f it-tools
# Recreate after an image update
docker compose -f docker-compose.it-tools.yml pull
docker compose -f docker-compose.it-tools.yml up -d
```