docs: add local deployment and upgrade guides

This commit is contained in:
JW 2026-03-27 12:51:42 +08:00
parent f610ca1e06
commit f5348133cd
5 changed files with 186 additions and 2 deletions

View file

@ -57,6 +57,11 @@ Any missing converter? Open an issue or pull request!
> [!WARNING]
> If you can't login, make sure you are accessing the service over localhost or https otherwise set HTTP_ALLOWED=true
For repository-specific local usage and upgrade workflow, see:
- [`docs/local-deploy.md`](docs/local-deploy.md)
- [`UPGRADE.md`](UPGRADE.md)
```yml
# docker-compose.yml
services:
@ -79,8 +84,6 @@ or
docker run -p 3000:3000 -v ./data:/app/data ghcr.io/c4illin/convertx
```
Then visit `http://localhost:3000` in your browser and create your account. Don't leave it unconfigured and open, as anyone can register the first account.
If you get unable to open database file run `chown -R $USER:$USER path` on the path you choose.
### Environment variables