Configuration¶

NILS can be configured through environment variables and configuration files.

Environment Variables¶

Configuration is managed through the .env file in the project root.

Core Settings¶

Variable	Default	Description
`API_URL`	`http://backend:8000`	Backend API URL (internal)
`DATABASE_URL`	`postgresql://...`	Main database connection
`METADATA_DATABASE_URL`	`postgresql://...`	Metadata database connection
`APP_ACCESS_TOKEN`	-	Access token for API authentication

Network Settings¶

Variable	Default	Description
`BIND_ADDRESS`	`127.0.0.1`	Address to bind services
`FRONTEND_PORT`	`5173`	Frontend web interface port
`BACKEND_PORT`	`8000`	Backend API port

Data Directories¶

Variable	Default	Description
`DATA_MOUNT`	`/data`	Path to mount external data
`DB_DATA_DIR`	`./resource/db`	PostgreSQL data directory
`BACKUP_DIR`	`./resource/backups`	Backup storage location

Example Configuration¶

# .env file

# API Configuration
API_URL=http://backend:8000
APP_ACCESS_TOKEN=your-secure-token-here

# Database
DATABASE_URL=postgresql://nils:nils@db:5432/nils
METADATA_DATABASE_URL=postgresql://nils:nils@db_metadata:5432/metadata

# Network (localhost only by default)
BIND_ADDRESS=127.0.0.1
FRONTEND_PORT=5173
BACKEND_PORT=8000

# Data paths
DATA_MOUNT=/path/to/your/dicom/data

Network Access¶

By default, NILS binds to 127.0.0.1 (localhost only). To allow network access:

# Enable network access
./scripts/manage.sh start --forward

Security

Enabling network access exposes NILS to your network. Ensure proper firewall rules and authentication are in place.

Database Configuration¶

NILS uses two PostgreSQL databases:

Main Database - Application data (cohorts, jobs, settings)
Metadata Database - DICOM metadata and classification results

Both databases are managed by Docker and persist data in the configured directories.

Backup and Restore¶

# Create backup
./scripts/manage.sh backup

# Restore from backup
./scripts/manage.sh restore backup-file.sql

Classification Rules¶

Classification rules are configured via YAML files in backend/src/classification/detection_yaml/:

base-detection.yaml - Core sequence types
technique-detection.yaml - Acquisition techniques
modifier-detection.yaml - Sequence modifiers
contrast-detection.yaml - Contrast agent detection

See Detection Infrastructure for detailed configuration.

Resource Limits¶

Docker Compose applies resource limits to prevent runaway processes:

# docker-compose.yml
services:
  frontend:
    deploy:
      resources:
        limits:
          memory: 2G

Adjust these limits based on your system resources.