53 lines
1011 B
Markdown
53 lines
1011 B
Markdown
## tingz: stay deployin'
|
|
|
|
A secure, lightweight HTTP service for deploying static site artifacts with per-user directory isolation. Tested on Debian 12.
|
|
|
|
### Quick Start
|
|
|
|
#### Production Deployment
|
|
|
|
**Prerequisites**:
|
|
- Go 1.25.3+
|
|
- Docker & Docker Compose
|
|
- Admin token (secure random string, `openssl rand -hex 16`)
|
|
|
|
##### Create Restricted User
|
|
|
|
```shell
|
|
addgroup --system tingz # note gid, needed for 2nd command
|
|
adduser --ingroup tingz --system --no-create-home --uid ${GID} --shell /usr/sbin/nologin tingz
|
|
usermod -aG tingz caddy
|
|
```
|
|
|
|
##### Deploy
|
|
|
|
1. Get source and checkout to a stable tag
|
|
|
|
```shell
|
|
git clone https://git.yigid.dev/fyb/tingz.git
|
|
cd tingz
|
|
git checkout v1.0
|
|
```
|
|
|
|
2. Edit the environment variables
|
|
|
|
```shell
|
|
cp .env.example .env
|
|
vim .env
|
|
```
|
|
|
|
3. Run with Docker
|
|
|
|
```shell
|
|
docker compose up --build -d
|
|
```
|
|
|
|
### API Usage
|
|
|
|
See [API.md](API.md).
|
|
|
|
### License & Credits
|
|
|
|
[GNU AGPL v3](LICENSE), by [Yigid BALABAN](https://git.yigid.dev/fyb).
|
|
|
|
Reach me at [hey@yigid.dev](mailto:hey@yigid.dev). |