mjoll/storagemanager repository overview

⁠mimir-storage-manager

⁠How to use the Docker image

docker run --rm --name mimir-storage-manager -v /tmp/mimir-storage-manager/config.json:/etc/mimir-storage-manager/config.json -v /tmp/mimir-storage-manager/secrets.json:/etc/mimir-storage-manager/secrets.json -v /tmp/mimir-storage-manager/media:/tmp/mimir-storage-manager/media -it mjoll/storagemanager:latest

⁠Config file

Store this content under /tmp/mimir-storage-manager/config.json or under an appropriate path and change the docker run command to reference the correct path.

You will typically only need to change the two first parameters to match your storage id and Mimir login.

{
  "MIMIR_STORAGE_MANAGER_ID": "storage-id",
  "MIMIR_STORAGE_MANAGER_EMAIL": "[email protected]",
  "AWS_API_PREFIX": "https://mimir.mjoll.no",
  "MIMIR_STORAGE_MANAGER_DOWNLOAD_PATH": "/tmp/mimir-storage-manager/media",
  "MIMIR_LOCAL_MEDIA_PATHS": [],
  "MIMIR_STORAGE_MANAGER_MAX_CONCURRENCY": 2,
  "MIMIR_STORAGE_MANAGER_POLLING_INTERVAL": 10,
  "MIMIR_STORAGE_MANAGER_MAX_WAIT_TIME": 600,
  "MIMIR_STORAGE_MANAGER_INIT_INTERVAL": 60000,
  "MIMIR_STORAGE_MANAGER_USE_SYMLINKS": false,
  "MIMIR_STORAGE_MANAGER_USE_NO_LINKS": false,
  "DOWNLOAD_PROGRESS_THROTTLE": 3,
}

⁠MIMIR_STORAGE_MANAGER_ID

Id of configured storage in Mimir. Can be found in Mimir -> Settings -> Storage -> "List of configured storages"

"<tenantid>-<name>"

⁠MIMIR_STORAGE_MANAGER_EMAIL

Username of the Mimir user StorageManager will run as

"[email protected]"

⁠AWS_API_PREFIX

Base URL to Mimir

"https://mimir.mjoll.no"

⁠MIMIR_STORAGE_MANAGER_DOWNLOAD_PATH

Path inside container where files are downloaded. This path should be mapped to a physical storage location by using Docker volume mapping.

"/tmp/mimir-storage-manager/media"

⁠MIMIR_LOCAL_MEDIA_PATHS

Extra paths where StorageManager can search for files before downloading from cloud.

[ "/tmp/mimir-storage-manager/local1", "/tmp/mimir-storage-manager/local2"]

⁠MIMIR_STORAGE_MANAGER_MAX_CONCURRENCY

Max number of simultaneous downloads

⁠MIMIR_STORAGE_MANAGER_POLLING_INTERVAL

Frequency of polling for new downloads. Value is in seconds.

⁠MIMIR_STORAGE_MANAGER_INIT_INTERVAL

Frequency of checking for server side changes. Value is in seconds. (internal)

⁠MIMIR_STORAGE_MANAGER_USE_SYMLINKS

Defines if StorageManager uses symlinks when creating files in folder structures. StorageManager uses hard links if this value is false or not set.

⁠MIMIR_STORAGE_MANAGER_USE_NO_LINKS

If it is set to true then StorageManager will not link files when creating those in folder structures and will ignore any configuration value set through MIMIR_STORAGE_MANAGER_USE_SYMLINKS option.

⁠DOWNLOAD_PROGRESS_THROTTLE

Frequency of progress reporting to server when downloading. Value is in seconds.

⁠MAX_CHUNK_SIZE

Maximum chunk size in bytes for downloading.

⁠MAX_CONNECTIONS_PER_DOWNLOAD

Maximum number of parallel connections for each download.

⁠MIMIR_TARGET_MEDIA_PATHS

A list of paths where StorageManager will check for existence of files before initiating a download. If a file is found in this path the download is assumed complete and no other file handling is performed.

[ "/tmp/mimir-storage-manager/target1", "/tmp/mimir-storage-manager/target2"]

⁠Secrets file

Store the following content under /tmp/mimir-stoage-manager/secrets.json

{
    "mimir_password":"mysecretpassword"
}