Storage

System

---

The Storage component manages Viserons database and how to store files. It helps you to organize segments, recordings and snapshots across multiple storage locations.

Files can be retained based on age and/or space used so that you never run out of storage.

Configuration​

storage:
  recorder:
    tiers:
      - path: /ssd/tier1
        events:
          max_age:
            days: 1
        continuous:
          max_age:
            days: 1
      - path: /hdd/tier2
        events:
          max_age:
            days: 7
  snapshots:
    tiers:
      - path: /config/tier1
        max_age:
          days: 1

Tiers​

Tiers is list of directories that Viseron can use to store files.

Viseron will always write to the first tier. max_size/max_age then decides when files are moved to the next tier or deleted.

It is of utmost importance that the first tier is a local disk or a RAM disk.
Viseron will not be able to detect new files and will not be able to gather file metadata if the first tier is a network share/NTFS mount.

When the max_size is hit the oldest files will be moved to the next tier.
When the age of a file exceeds the max_age, it will be moved to the next tier.
If the current tier is the last one, the file is deleted instead.

Continuous (24/7) recordings​

To allocate space for continuous recordings for all cameras you use the continuous configuration option for a tier. The below example will store 10gb of continuous recordings per camera in the default location /segments. No events will be stored.

storage:
  recorder:
    tiers:
      - path: / # Will store segments in /segments folder inside the container
        continuous:
          max_size:
            gb: 10

Advanced configuration​

For more advanced setups, min_size and min_age can be used. They are best explained in a config.yaml example:

storage:
  recorder:
    tiers:
      - path: /mnt/ramdisk # Store continuous recordings and events here
        move_on_shutdown: true
        continuous:
          max_size: # If this target is hit, segments will be moved to the next tier
            gb: 1
          max_age: # If this target is hit, segments will be moved to the next tier
            days: 1
        events:
          max_size: # If this target is hit, segments will be moved to the next tier
            gb: 1
          max_age: # If this target is hit, segments will be moved to the next tier
            days: 1
      - path: /mnt/ssd # Store only events here
        events:
          min_size: # If max_age is hit, keep at least 1gb
            gb: 1
          max_size: # If this target is hit, segments will be moved to the next tier
            gb: 10
          max_age: # If this target is hit, segments will be moved to the next tier ONLY if size is larger than min_size
            days: 7
      - path: /mnt/nas # Store only events here
        events:
          min_age: # If max_size is hit, keep at least 30 days worth of recordings. DOES NOT AFFECT max_age
            days: 30
          max_size: # If this target is hit, recordings/segments will be DELETED ONLY if they are older than 30 days
            gb: 100

Database Migrations​

Viseron will sometimes require database migrations to be run when you upgrade Viseron. This is done automatically on startup, and you should avoid stopping Viseron while migrations are running.

External database​

By default Viseron runs a local PostgreSQL database inside the container. If you want to use an external database, you can set the POSTGRES_DATABASE_URL environment variable to point to your database.

This is an example of a docker-compose.yaml file that runs Viseron alongside a PostgreSQL database container:

services:
  viseron-postgres-container:
    image: postgres:latest
    restart: always
    shm_size: "128mb"
    environment:
      POSTGRES_USER: viseron
      POSTGRES_PASSWORD: example
      POSTGRES_DB: viseron

  viseron:
    # Add the below to your existing Docker Compose configuration
    environment:
      - POSTGRES_DATABASE_URL=postgresql://viseron:example@viseron-postgres-container/viseron
    depends_on:
      - viseron-postgres-container

Troubleshooting​

logger:
  logs:
    viseron.components.storage: debug
    sqlalchemy.engine: debug