Local Files

You can customize the paths by modifying the following environment variables that are used to define the important paths:

  • DATA_ROOT, equal to /data/ by default and contains:

    • a SQLite database file named <DATA_ROOT>/db.sqlite3 if the DATABASE_URL variable is not set.

    • <DATA_ROOT>/plugins is the directory for storing future plugins.

    • <DATA_ROOT>/secrets/ is the directory for storing cached secrets (actual secrets are stored into the database).

    • <DATA_ROOT>/static/ is the directory for web assets files.

    • <DATA_ROOT>/run/ is the directory for PID files.

    Note

    You should not need to change the <DATA_ROOT> value, which requires running the interdiode-ctl configuration apply command after any change.

  • MAIN_STORAGE_DIR, equal to <DATA_ROOT>/files/ by default, is the main storage directory for all permanent files. You can also use a S3 storage by using a URL like s3:https://access-key:secret-key@domain.name:port/bucket and the S3_REGION variable.

  • LOCAL_CACHE_DIR, equal to <DATA_ROOT>/caches/ by default, is the directory for temporary files during download and transfer operations. It contains the following subdirectories:

    • <LOCAL_CACHE_DIR>/source-cache/ is the directory for caching source files. This cache can be safely shared between all processes to save space.

    • <LOCAL_CACHE_DIR>/receiving/ is the directory used by TCP and UDP protocols on the red side for receiving files sent by the black side.

    • <LOCAL_CACHE_DIR>/sending/ is the directory for files being prepared and sent by the black side to the red side by TCP and UDP protocols (these files are deleted after the transfer when TRANSFER_KEEP_TRANSFERS=false).

    • <LOCAL_CACHE_DIR>/transfer/ is the directory for caching files during transfer operations.

    • <LOCAL_CACHE_DIR>/corrupted/ is the directory for storing corrupted files during transfer operations when TRANSFER_KEEP_CORRUPTED_IMPORTS=true.

    • <LOCAL_CACHE_DIR>/error/ is the directory for storing files that encountered errors during transfer or import operations when TRANSFER_KEEP_FAILED_IMPORTS=true.

    • <LOCAL_CACHE_DIR>/success/ is the directory for storing successfully transferred files during transfer operations when TRANSFER_KEEP_IMPORTS=true.

    • <LOCAL_CACHE_DIR>/tmp/ is the directory for preparing exported files before their transfer to the red side.

  • LOG_DIR. If set, it will be used to store the various log files. Otherwise, logs will be written to standard output (stdout).

Attention

The only directory that should be carefully backed up is the <MAIN_STORAGE_DIR> directory, which contains all permanent files. The other directories are mainly used for cache and temporary files, and can be recreated if necessary.

Attention

The <LOCAL_CACHE_DIR>/tmp/ and <LOCAL_CACHE_DIR>/transfer/ directories must be on the same partition to allow atomic file move operations.