Weavestream API
| Description / name | Input element |
|---|---|
| Container Registry |
Backend REST API and MCP server for Weavestream, an open-source self-hosted IT documentation and asset management platform.
| Port | 4000 |
| Registry | ghcr.io/daemonless/weavestream-api |
| Daemonless | daemonless/weavestream-api |
| Source | Weavestream/Weavestream |
| Website | weavestream.io |
Version Tags
| Tag | Description | Best For |
|---|---|---|
latest |
FreeBSD Port. Built from latest FreeBSD packages. | Most users — recommended. |
Before deploying, ensure your host environment is ready. See the Quick Start Guide for host setup instructions, including the security model for host vs. container privileges.
Interactive Configuration
Parameters
Environment Variables
| Variable | Default | Description |
|---|---|---|
PUID |
1000 |
User ID for the API process |
PGID |
1000 |
Group ID for the API process |
TZ |
UTC |
Timezone for the container |
DATABASE_URL |
postgresql://weavestream:REPLACEME@postgres:5432/weavestream |
PostgreSQL connection string (e.g. postgresql://user:pass@host:5432/db) |
REDIS_URL |
redis://:REPLACEME@redis:6379/0 |
Redis or Valkey connection string (e.g. redis://host:6379/0) |
APP_URL |
http://localhost:3000 |
Public origin of the web UI (default: http://localhost:3000) |
API_URL |
http://localhost:3000/api |
Public origin of the API (default: http://localhost:3000/api) |
JWT_SIGNING_KEY |
REPLACEME_32_BYTES_BASE64 |
32-byte base64 secret, the same in api and worker |
MFA_ENCRYPTION_KEY |
REPLACEME_32_BYTES_BASE64 |
32-byte base64 secret, the same in api and worker |
PASSWORD_ENCRYPTION_KEY |
REPLACEME_32_BYTES_BASE64 |
32-byte base64 secret, the same in api and worker |
INTEGRATION_SECRET_KEY |
REPLACEME_32_BYTES_BASE64 |
32-byte base64 secret, the same in api and worker |
SMTP_SECRET_KEY |
REPLACEME_32_BYTES_BASE64 |
32-byte base64 secret, the same in api and worker |
COOKIE_SIGNING_KEY |
REPLACEME_32_BYTES_BASE64 |
32-byte base64 secret, the same in api, worker and web |
CSRF_SIGNING_KEY |
REPLACEME_32_BYTES_BASE64 |
32-byte base64 secret, the same in api and worker |
Volumes
| Path | Description |
|---|---|
/var/lib/weavestream/files |
Uploaded attachments and documents |
/var/lib/weavestream/backup |
Backup storage directory (read-only for API, worker writes) |
Ports
| Port | Protocol | Description |
|---|---|---|
4000 |
TCP | API HTTP listener (NestJS) |
This image is part of the Weavestream Stack.
Implementation Details
- Architectures: amd64
- User:
bsd(UID/GID set via PUID/PGID). Defaults to1000:1000. - Base: Built on
ghcr.io/daemonless/base(FreeBSD 15.1).
Need help? Join our Discord community.