Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
87 changes: 48 additions & 39 deletions doc/mkdocs/docs/configuration/environment-variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,90 +4,99 @@ Vollständige Referenz aller Einstellungen in der `.env`-Datei.

## Datenbank

| Variable | Beschreibung | Standard |
|----------|--------------|----------|
| `DATABASE_URL` | Pfad zur SQLite-Datenbank | `file:./database/dev.db` |
| `COVERIMAGE_FILESTORAGE_PATH` | Pfad zu Cover Images | `/app/images` |

| Variable | Beschreibung | Standard |
| ----------------------------- | ------------------------- | ------------------------ |
| `DATABASE_URL` | Pfad zur SQLite-Datenbank | `file:./database/dev.db` |
| `COVERIMAGE_FILESTORAGE_PATH` | Pfad zu Cover Images | `/app/images` |

```env
DATABASE_URL=file:./database/dev.db
```

## Authentifizierung und Sicherheit

| Variable | Beschreibung | Standard |
|----------|--------------|----------|
| `AUTH_ENABLED` | Login erforderlich? | `true` |
| `NEXTAUTH_SECRET` | Geheimer Seed für Session-Tokens | *(muss gesetzt werden)* |
| `SECURITY_HEADERS` | CSRP headers für HTTP calls | `insecure` |

| Variable | Beschreibung | Standard |
| ------------------ | -------------------------------- | ----------------------- |
| `AUTH_ENABLED` | Login erforderlich? | `true` |
| `NEXTAUTH_SECRET` | Geheimer Seed für Session-Tokens | _(muss gesetzt werden)_ |
| `SECURITY_HEADERS` | CSRP headers für HTTP calls | `insecure` |

```env
AUTH_ENABLED=true
NEXTAUTH_SECRET=einLangesZufälligesGeheimnis123!
```

!!! warning "AUTH_SECRET"
Verwende einen langen, zufälligen String. Ändere ihn nicht nachträglich, sonst werden alle Nutzer ausgeloggt.
Verwende einen langen, zufälligen String. Ändere ihn nicht nachträglich, sonst werden alle Nutzer ausgeloggt.

## Ausleihzeiten

| Variable | Beschreibung | Standard |
|----------|--------------|----------|
| `RENTAL_DURATION_DAYS` | Leihfrist in Tagen | `21` |
| `EXTENSION_DURATION_DAYS` | Verlängerung in Tagen | `14` |
| `MAX_EXTENSIONS` | Maximale Verlängerungen | `2` |
| Variable | Beschreibung | Standard |
| ------------------------- | ----------------------- | -------- |
| `RENTAL_DURATION_DAYS` | Leihfrist in Tagen | `21` |
| `EXTENSION_DURATION_DAYS` | Verlängerung in Tagen | `14` |
| `MAX_EXTENSIONS` | Maximale Verlängerungen | `2` |

```env
RENTAL_DURATION_DAYS=21
EXTENSION_DURATION_DAYS=14
MAX_EXTENSIONS=2
```


## Benutzerausweise

| Variable | Beschreibung | Standard |
|----------|--------------|----------|
| `USERID_LABEL_IMAGE` | Hintergrundbild | `ausweis_hintergrund.png` |
| `USERLABEL_WIDTH` | Breite des Ausweises | `42vw` |
| `USERLABEL_PER_PAGE` | Ausweise pro Seite | `6` |
| `USERLABEL_SEPARATE_COLORBAR` | Farbbalken-Höhe (px) | `0` |
| `USERLABEL_BARCODE` | Barcode-Position | `["10%","60%","30%","15%","code128"]` |
| Variable | Beschreibung | Standard |
| ----------------------------- | -------------------- | ------------------------------------- |
| `USERID_LABEL_IMAGE` | Hintergrundbild | `ausweis_hintergrund.png` |
| `USERLABEL_WIDTH` | Breite des Ausweises | `42vw` |
| `USERLABEL_PER_PAGE` | Ausweise pro Seite | `6` |
| `USERLABEL_SEPARATE_COLORBAR` | Farbbalken-Höhe (px) | `0` |
| `USERLABEL_BARCODE` | Barcode-Position | `["10%","60%","30%","15%","code128"]` |

### Datenzeilen

| Variable | Format |
|----------|--------|
| Variable | Format |
| ------------------ | --------------------------------------------------------------------- |
| `USERLABEL_LINE_1` | `["User.firstName User.lastName","75%","3%","35vw","2pt","black",14]` |
| `USERLABEL_LINE_2` | `["User.schoolGrade","80%","3%","35vw","2pt","black",12]` |
| `USERLABEL_LINE_2` | `["User.schoolGrade","80%","3%","35vw","2pt","black",12]` |

**Format**: `["Inhalt", Top, Left, Breite, Padding, Farbe, Schriftgröße]`

Mehr Details: [Benutzerausweise konfigurieren](user-cards.md)

## Mahnschreiben

| Variable | Beschreibung | Standard |
|----------|--------------|----------|
| Variable | Beschreibung | Standard |
| ------------------- | -------------- | ----------------------- |
| `REMINDER_TEMPLATE` | Template-Datei | `mahnung-template.docx` |
| `SCHOOL_NAME` | Schulname | `"Meine Schule"` |
| `SCHOOL_ADDRESS` | Adresse | `"Musterstraße 1"` |
| `SCHOOL_CITY` | Ort | `"12345 Musterstadt"` |
| `SCHOOL_NAME` | Schulname | `"Meine Schule"` |
| `SCHOOL_ADDRESS` | Adresse | `"Musterstraße 1"` |
| `SCHOOL_CITY` | Ort | `"12345 Musterstadt"` |

Mehr Details: [Mahnschreiben konfigurieren](reminders.md)

## Sonstiges

| Variable | Beschreibung | Standard |
|----------|--------------|----------|
| `PORT` | Server-Port | `3000` |
| `MAX_MIGRATION_SIZE` | Max. Import-Größe (MB) | `250` |
| `RENTAL_SORT_BOOKS` | Sortierung in Leihe | `title_asc` |
| `GOOGLE_BOOKS_API_KEY` | Google Books API key für die Google Schnittstelle für Buchinfos | ` ` |
| Variable | Beschreibung | Standard |
| ---------------------- | --------------------------------------------------------------- | ----------- |
| `PORT` | Server-Port | `3000` |
| `MAX_MIGRATION_SIZE` | Max. Import-Größe (MB) | `250` |
| `RENTAL_SORT_BOOKS` | Sortierung in Leihe | `title_asc` |
| `GOOGLE_BOOKS_API_KEY` | Google Books API key für die Google Schnittstelle für Buchinfos | ` ` |
| `RENTAL_SORT_BOOKS` | Sortierung in Leihe | `title_asc` |

# Prefix und Suffix für den Barcode am Büchereiausweis.

| Variable | Beschreibung | Standard |
| -------------------------- | ----------------------------------------------------------------- | -------- |
| `USERLABEL_BARCODE_PREFIX` | Optionales Steuerzeichen vor Eingabe der Ausweisnummer (z.B. ESC) | `` |
| `USERLABEL_BARCODE_SUFFIX` | Suffix für den Barcode (z.B. um mit einem Zeilenumbruch zu enden) | `` |

Beispiele: Escape: \x1B | Enter: \x0D | Tabulator: \x09 | Backspace: \x08 | Line Feed: \x0A | Home (Pos 1): \x01

Weitere HEX Codes für Steuerzeichen:
https://www.ionos.at/digitalguide/server/knowhow/ascii-tabelle/
sieheAbschnitt Steuerzeichen, den Code aus Spalte "HEX" nach dem \x anhängen

## Nach Änderungen

Expand Down