zwitschi/linearvoid
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 9 Wiki Activity

update setup guide with repo URL, Gitea registry config, and production deployment instructions

Browse Source
This commit is contained in:
zwitschi committed 2026-08-02 17:44:48 +02:00
1 parent b80c7c4743
commit df7a1b33cc
1 file changed
+10 -3
Download Patch File Download Diff File Expand all files Collapse all files
SETUP.md
+10 -3
View File
@@ -1,6 +1,6 @@
# Linear Void Setup Guide # Linear Void Setup Guide
This guide covers prerequisites, environment setup, running the application locally and in production, and troubleshooting. It references the architecture documentation (`docs/architecture/README.md`) and ADRs in `docs/architecture/adr/`. This guide covers prerequisites, environment setup, running the application locally and in production, and troubleshooting. It references the [architecture documentation](./docs/architecture/README.md)(`docs/architecture/README.md`).
## Prerequisites ## Prerequisites
@@ -16,7 +16,7 @@ This guide covers prerequisites, environment setup, running the application loca
1. **Clone the Repository** (if not already done): 1. **Clone the Repository** (if not already done):
```bash ```bash
git clone <repository-url> git clone https://git.allucanget.biz/zwitschi/linearvoid.git
cd linearvoid cd linearvoid
``` ```
@@ -39,6 +39,12 @@ This guide covers prerequisites, environment setup, running the application loca
CLOUDFLARE_API_TOKEN=your-cloudflare-api-token CLOUDFLARE_API_TOKEN=your-cloudflare-api-token
MEDIA_DOMAIN=media.example.com MEDIA_DOMAIN=media.example.com
# Gitea Container Registry (for self-hosted Docker images)
GITEA_REGISTRY_URL=git.allucanget.biz
GITEA_USERNAME=your-gitea-username
GITEA_TOKEN=your-gitea-token
GITEA_REGISTRY_NAMESPACE=zwitschi/linearvoid
# Chat / Database # Chat / Database
REDIS_URL=redis://redis:6379/0 REDIS_URL=redis://redis:6379/0
DATABASE_URL=sqlite://./data/chat.db # or postgres://user:pass@db:5432/linearvoid DATABASE_URL=sqlite://./data/chat.db # or postgres://user:pass@db:5432/linearvoid
@@ -112,7 +118,8 @@ This guide covers prerequisites, environment setup, running the application loca
- Apply the Worker from `infrastructure/cloudflare/worker.js` for advanced header management. - Apply the Worker from `infrastructure/cloudflare/worker.js` for advanced header management.
3. **Deploy**: 3. **Deploy**:
- Copy the project to the VPS. - Copy the project to the VPS.
- Run `docker compose up -d --build`. - Use production compose: `docker compose -f docker-compose.prod.yml up -d`
- Or pull from Gitea registry: `docker compose -f docker-compose.prod.yml pull && docker compose -f docker-compose.prod.yml up -d`
- Configure systemd to manage the Docker Compose stack. - Configure systemd to manage the Docker Compose stack.
4. **Monitoring**: Access Grafana at the exposed port for dashboards (included in `monitoring/grafana/dashboard.json`). 4. **Monitoring**: Access Grafana at the exposed port for dashboards (included in `monitoring/grafana/dashboard.json`).