Inventaire should be configured for collaborative catalog consistency and external metadata sync governance. The application uses environment variables for configuration, which are typically defined in the Docker Compose file or in a dedicated .env file.
The following environment variables are essential for basic operation:
# Application settings
INV_APP_HOSTNAME=inventaire.example.com
INV_APP_PORT=3000
# Database configuration
INV_DATABASE_COUCHDB_URL=http://admin:secure_password@couchdb:5984
INV_DATABASE_COUCHDB_NAME=inventaire
# Elasticsearch configuration
INV_ELASTICSEARCH_HOST=elasticsearch
INV_ELASTICSEARCH_PORT=9200
# Email settings
INV_EMAIL_ALERTS_TO=admin@example.com
INV_SMTP_HOST=smtp.example.com
INV_SMTP_PORT=587
INV_SMTP_SECURE=false
INV_SMTP_USER=username
INV_SMTP_PASS=password
# Security settings
INV_SESSION_SECRET=replace_with_strong_secret_key
INV_RECAPTCHA_SITE_KEY=your_recaptcha_site_key
INV_RECAPTCHA_SECRET_KEY=your_recaptcha_secret_key
# External API keys
INV_WIKIDATA_API_URL=https://www.wikidata.org/w/api.php
INV_ISBN_HYPHENS_JSON_URL=https://raw.githubusercontent.com/inventaire/isbn-hyphens/master/isbn.hyphenation.json
When using Docker Compose, configure these variables in the docker-compose.yml file:
version: '3.8'
services:
server:
image: codeberg.org/inventaire/inventaire:latest
restart: unless-stopped
depends_on:
- couchdb
- elasticsearch
ports:
- "3000:3000"
environment:
# Application settings
- INV_APP_HOSTNAME=inventaire.example.com
- INV_APP_PORT=3000
# Database settings
- INV_DATABASE_COUCHDB_URL=http://admin:replace_with_secure_password@couchdb:5984
- INV_DATABASE_COUCHDB_NAME=inventaire
# Elasticsearch settings
- INV_ELASTICSEARCH_HOST=elasticsearch
- INV_ELASTICSEARCH_PORT=9200
# Email settings
- INV_EMAIL_ALERTS_TO=admin@example.com
- INV_SMTP_HOST=smtp.example.com
- INV_SMTP_PORT=587
- INV_SMTP_SECURE=false
- INV_SMTP_USER=smtp_username
- INV_SMTP_PASS=smtp_password
# Security settings
- INV_SESSION_SECRET=replace_with_strong_session_secret
networks:
- inventaire_net
networks:
inventaire_net:
driver: bridge
# Site name and branding
INV_APP_NAME="My Inventaire Instance"
INV_APP_DESCRIPTION="Personal book inventory system"
# Registration settings
INV_ACCOUNT_SIGNUP_OPEN=true
INV_ACCOUNT_ACTIVATION_REQUIRED=true
# API rate limiting
INV_RATE_LIMIT_ENABLED=true
INV_RATE_LIMIT_WINDOW_MS=900000
INV_RATE_LIMIT_MAX_REQUESTS=100
# File upload settings
INV_UPLOADS_MAX_FILE_SIZE=5242880 # 5MB in bytes
INV_UPLOADS_ALLOWED_EXTENSIONS=jpg,jpeg,png,gif,pdf
Back up the following components for complete recovery:
Validate restore procedures by testing user login, performing a core business transaction (adding/editing an item), and checking reports/exports.
For infrastructure-as-code approaches, consider using configuration management tools like Ansible, Terraform, or similar to manage Inventaire configurations consistently across environments.
Any questions?
Feel free to contact us. Find all contact information on our contact page.