alexsun/compose-anything
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: add trailbase

Browse Source
This commit is contained in:
Sun-ZhenXing
2025-12-29 11:33:23 +08:00
parent 74cc6b49a7
commit 4c7b3afc10
6 changed files with 695 additions and 406 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
src/trailbase/.env.example Normal file
View File

@@ -0,0 +1,23 @@
# TrailBase configuration
# Pin to the latest stable image tag
TRAILBASE_VERSION=0.22.4
# Host port mapping (maps to container port 4000)
TRAILBASE_PORT_OVERRIDE=4000
# Enable detailed stack traces for debugging (set to 0 in production)
TRAILBASE_RUST_BACKTRACE=1
# Logging configuration for the json-file driver
TRAILBASE_LOG_MAX_SIZE=100m
TRAILBASE_LOG_MAX_FILE=3
# Timezone
TZ=UTC
# Resource limits
TRAILBASE_CPU_LIMIT=1.0
TRAILBASE_MEMORY_LIMIT=1G
TRAILBASE_CPU_RESERVATION=0.25
TRAILBASE_MEMORY_RESERVATION=256M

110
src/trailbase/README.md Normal file
View File

@@ -0,0 +1,110 @@
# TrailBase
[English](./README.md) | [中文](./README.zh.md)
TrailBase is an open, single-binary Firebase alternative that ships type-safe REST & realtime APIs, a built-in admin UI, WebAssembly runtime, and authentication powered by Rust, SQLite, and Wasmtime.
This compose bundle runs the official Docker image with sensible defaults so you can immediately explore the admin console, build data models, and deploy edge components without extra dependencies.
## Services
- `trailbase`: TrailBase application server with the embedded admin UI, REST API, and realtime channels.
## Quick Start
1. Copy the sample environment file and adjust values as needed:
```bash
cp .env.example .env
```
2. Launch the stack:
```bash
docker compose up -d
```
3. Tail the logs to capture the auto-generated administrator credentials from the first boot:
```bash
docker compose logs -f trailbase
```
4. Open `http://localhost:4000/_/admin` and sign in with the printed credentials (or create your own admin; see below).
## Default Endpoints
| Endpoint | Description |
| --------------------------------------- | --------------------------- |
| `http://localhost:4000/_/admin` | Admin UI |
| `http://localhost:4000/api/healthcheck` | Health probe used by Docker |
| `http://localhost:4000/_/auth/login` | Optional Auth UI component |
## Environment Variables
| Variable | Description | Default |
| ------------------------------ | --------------------------------------------------- | -------- |
| `TRAILBASE_VERSION` | Docker image tag pulled from Docker Hub | `0.22.4` |
| `TRAILBASE_PORT_OVERRIDE` | Host port that maps to container port `4000` | `4000` |
| `TRAILBASE_RUST_BACKTRACE` | Enables verbose Rust backtraces for troubleshooting | `1` |
| `TRAILBASE_LOG_MAX_SIZE` | Max log file size for the `json-file` driver | `100m` |
| `TRAILBASE_LOG_MAX_FILE` | Number of rotated log files to keep | `3` |
| `TRAILBASE_CPU_LIMIT` | CPU limit applied via `deploy.resources.limits` | `1.0` |
| `TRAILBASE_MEMORY_LIMIT` | Memory limit applied via `deploy.resources.limits` | `1G` |
| `TRAILBASE_CPU_RESERVATION` | CPU reservation to keep TrailBase responsive | `0.25` |
| `TRAILBASE_MEMORY_RESERVATION` | Memory reservation to protect against eviction | `256M` |
| `TZ` | Timezone passed to the container | `UTC` |
See `.env.example` for the complete, commented list.
## Volumes
- `trailbase_data`: Stores the `traildepot` directory which contains the SQLite database, WASM components, authentication secrets, and uploaded assets. Back up this volume to preserve your project.
## Bootstrap & Admin Accounts
- On the first start TrailBase prints temporary administrator credentials to the logs. Capture them with `docker compose logs -f trailbase`.
- Create additional verified users (or rotate the admin) without restarting the service:
```bash
docker compose exec trailbase /app/trail user add admin@example.com "StrongPassw0rd!"
```
- To inspect user records or rotate passwords later, you can use other `trail` CLI commands from the same container.
## Optional Components
- The container already ships the official Auth UI WASM component under `/app/traildepot/wasm`. If you need extra components, install them at runtime:
```bash
docker compose exec trailbase /app/trail components add trailbase/auth_ui
docker compose exec trailbase /app/trail components add your-org/your-component
```
- Mount your own WASM components or configuration alongside the `trailbase_data` volume if you prefer to keep them under version control.
## Health & Maintenance
- The included healthcheck hits `http://localhost:4000/api/healthcheck`. You can perform manual probes with `curl http://localhost:4000/api/healthcheck`.
- Back up the data volume periodically:
```bash
docker compose stop trailbase
docker run --rm -v compose-anything_trailbase_data:/data -v $(pwd):/backup alpine tar czf /backup/trailbase-backup.tar.gz -C /data .
docker compose start trailbase
```
- Restore by reversing the `tar` command into the named volume.
## Security Notes
- Rotate the default admin credentials immediately and restrict the exposed port with a firewall or reverse proxy.
- Set `TRAILBASE_RUST_BACKTRACE=0` in production to avoid verbose stack traces in logs.
- Terminate TLS with a reverse proxy such as Caddy, nginx, or Traefik and place TrailBase behind it for HTTPS.
- Back up the `trailbase_data` volume before upgrading to new releases.
## References
- Project website: [https://trailbase.io](https://trailbase.io)
- GitHub repository: [https://github.com/trailbaseio/trailbase](https://github.com/trailbaseio/trailbase)
- Documentation: [https://trailbase.io/reference](https://trailbase.io/reference)
- License: Open Software License 3.0 (OSL-3.0)

110
src/trailbase/README.zh.md Normal file
View File

@@ -0,0 +1,110 @@
# TrailBase
[English](./README.md) | [中文](./README.zh.md)
TrailBase 是一个开源的单可执行后端，提供 type-safe REST 与实时 API、内置管理界面、WebAssembly 运行时以及身份认证功能，底层由 Rust、SQLite 与 Wasmtime 驱动。
本配置使用官方 Docker 镜像并提供合理的默认值，方便你立即访问管理后台、定义数据模型并在本地体验 TrailBase。
## 服务
- `trailbase`：包含管理后台、REST API 以及实时通道的核心服务。
## 快速开始
1. 复制示例环境文件并按需修改：
```bash
cp .env.example .env
```
2. 启动服务：
```bash
docker compose up -d
```
3. 首次启动会在日志中输出自动生成的管理员账号，使用以下命令查看：
```bash
docker compose logs -f trailbase
```
4. 打开 `http://localhost:4000/_/admin`，使用日志中的凭据登录（或按照下文创建新的管理员）。
## 默认访问入口
| 入口 | 说明 |
| --------------------------------------- | ------------------- |
| `http://localhost:4000/_/admin` | 管理界面 |
| `http://localhost:4000/api/healthcheck` | 健康检查端点 |
| `http://localhost:4000/_/auth/login` | 可选的 Auth UI 入口 |
## 环境变量
| 变量名 | 描述 | 默认值 |
| ------------------------------ | ----------------------------------- | -------- |
| `TRAILBASE_VERSION` | Docker 镜像标签 | `0.22.4` |
| `TRAILBASE_PORT_OVERRIDE` | 暴露到宿主机的端口（容器端口 4000） | `4000` |
| `TRAILBASE_RUST_BACKTRACE` | 是否输出 Rust 堆栈，便于排障 | `1` |
| `TRAILBASE_LOG_MAX_SIZE` | `json-file` 日志的最大文件大小 | `100m` |
| `TRAILBASE_LOG_MAX_FILE` | 日志轮转时保留的文件数量 | `3` |
| `TRAILBASE_CPU_LIMIT` | CPU 限制（`deploy.resources`） | `1.0` |
| `TRAILBASE_MEMORY_LIMIT` | 内存限制 | `1G` |
| `TRAILBASE_CPU_RESERVATION` | CPU 预留 | `0.25` |
| `TRAILBASE_MEMORY_RESERVATION` | 内存预留 | `256M` |
| `TZ` | 容器时区 | `UTC` |
完整说明请参考 `.env.example`。
## 数据卷
- `trailbase_data`：对应容器内的 `traildepot`，保存 SQLite 数据库、WASM 组件、认证密钥及上传的静态资源。升级或迁移前务必备份该卷。
## 初始化与管理员账号
- 首次启动后，TrailBase 会在日志中打印一次性管理员账号与密码。请立即登录并修改。
- 也可以直接在容器内创建新的已验证用户：
```bash
docker compose exec trailbase /app/trail user add admin@example.com "StrongPassw0rd!"
```
- 使用同一个 `trail` CLI 可以重置密码、导入导出数据等，不需要重启服务。
## 可选组件
- 镜像已经预置官方 Auth UI WASM 组件，若需要其他组件，可在运行中安装：
```bash
docker compose exec trailbase /app/trail components add trailbase/auth_ui
docker compose exec trailbase /app/trail components add your-org/your-component
```
- 如果希望通过 Git 管理组件或静态资源，可以将本地目录挂载到 `trailbase_data`。
## 健康检查与维护
- 默认健康检查请求 `http://localhost:4000/api/healthcheck`，也可以手动使用 `curl` 进行验证。
- 备份流程示例：
```bash
docker compose stop trailbase
docker run --rm -v compose-anything_trailbase_data:/data -v $(pwd):/backup alpine tar czf /backup/trailbase-backup.tar.gz -C /data .
docker compose start trailbase
```
- 恢复时将备份解压回同名数据卷即可。
## 安全提示
- 启动后立即更换默认管理员凭据，并在防火墙或反向代理层限制 4000 端口的访问。
- 生产环境建议将 `TRAILBASE_RUST_BACKTRACE` 设置为 `0`，避免日志泄露系统细节。
- 配合 Caddy、nginx 或 Traefik 等反向代理启用 TLS，必要时再开启 WAF、IP 白名单等防护。
- 升级新版本前务必备份 `trailbase_data` 数据卷。
## 参考资料
- 官网：<https://trailbase.io>
- 仓库：<https://github.com/trailbaseio/trailbase>
- 文档：<https://trailbase.io/reference>
- 许可证：Open Software License 3.0（OSL-3.0）

44
src/trailbase/docker-compose.yaml Normal file
View File

@@ -0,0 +1,44 @@
# TrailBase - Firebase alternative with type-safe REST & realtime APIs
# Project: https://github.com/trailbaseio/trailbase
# Default access: http://localhost:4000/_/admin
# Notes:
# - The container already ships the admin UI WASM component.
# - Initial admin credentials are printed to the logs on first boot.
# - Use `trail user add <email> <password>` to create additional verified users.
x-defaults: &defaults
restart: unless-stopped
logging:
driver: json-file
options:
max-size: ${TRAILBASE_LOG_MAX_SIZE:-100m}
max-file: "${TRAILBASE_LOG_MAX_FILE:-3}"
services:
trailbase:
<<: *defaults
image: ${GLOBAL_REGISTRY:-}trailbase/trailbase:${TRAILBASE_VERSION:-0.22.4}
ports:
- "${TRAILBASE_PORT_OVERRIDE:-4000}:4000"
environment:
- TZ=${TZ:-UTC}
- RUST_BACKTRACE=${TRAILBASE_RUST_BACKTRACE:-1}
volumes:
- trailbase_data:/app/traildepot
healthcheck:
test: ["CMD", "curl", "--fail", "--silent", "--show-error", "http://localhost:4000/api/healthcheck"]
interval: 30s
timeout: 10s
retries: 5
start_period: 60s
deploy:
resources:
limits:
cpus: ${TRAILBASE_CPU_LIMIT:-1.0}
memory: ${TRAILBASE_MEMORY_LIMIT:-1G}
reservations:
cpus: ${TRAILBASE_CPU_RESERVATION:-0.25}
memory: ${TRAILBASE_MEMORY_RESERVATION:-256M}
volumes:
trailbase_data: