Quick Start hinzugefügt

2026-06-28 19:50:34 +00:00
parent 360067086c
commit f89f011a22
+134
@@ -0,0 +1,134 @@
# Quick Start
## 1. Prepare environment
Copy the sample environment file:
```bash
cp .env.sample .env
```
Edit `.env` and set at least:
```env
ROMEXIS_VERSION=6.5.3.444.203
TARGETARCH=amd64
REGISTRY=gitea.buchhorster.de/patrick
ROMEXIS_IMAGE=romexis-server
HOST_IP=<your-server-ip>
MSSQL_SA_PASSWORD=<strong-password>
ROMEXIS_DB_PASSWORD=<strong-password>
```
---
## 2. Start default MSSQL stack
```bash
docker compose up -d
```
Show logs:
```bash
docker compose logs -f romexis
docker compose logs -f mssql
```
---
## 3. Start Firebird stack
If using the Firebird compose variant:
```bash
docker compose -f docker-compose.firebird.yml up -d
```
Or combine the base compose file with a Firebird override:
```bash
docker compose -f docker-compose.yml -f docker-compose.firebird.yml up -d
```
---
## 4. Recreate after image changes
```bash
docker compose up --force-recreate -d
```
With rebuild:
```bash
docker compose up --build --force-recreate -d
```
No cache rebuild:
```bash
docker compose build --no-cache --pull
docker compose up --force-recreate -d
```
---
## 5. Open a shell in the Romexis container
```bash
docker exec -it romexis-server bash
```
If bash is unavailable:
```bash
docker exec -it romexis-server sh
```
With Compose:
```bash
docker compose exec romexis bash
```
---
## 6. Check database initialization
Inside the Romexis container:
```bash
/opt/init-romexis-db.sh
```
Verbose database initialization:
```bash
DB_CREATE_VERBOSE=1 /opt/init-romexis-db.sh
```
For Firebird debugging:
```bash
ISQL=isql-fb DB_CREATE_VERBOSE=1 bash -x /opt/init-romexis-firebird-db.sh
```
---
## 7. Stop the stack
```bash
docker compose down
```
Stop and remove volumes:
```bash
docker compose down -v
```
Use volume removal carefully because it deletes persistent database/application data.