Configuration

Ramifier Configuration

This page explains how to configure Ramifier using the config.yaml file.

---

1. Configuration File Location

Ramifier looks for the configuration file at:

~/.config/ramifier/config.yaml

If it does not exist, create it manually.

---

2. Basic Structure

Example configuration:

targets:
  - name: my_folder
    path: /path/to/folder
    backup_path: /backup/path          # optional, default: ~/.local/share/ramifier/<target_name>
    max_backups: 5                     # optional, default: 3
    interval: 45                       # optional, default: 30 (minutes)
    dynamic_interval: true             # optional, default: false
    max_dynamic_interval: 150          # optional, default: 100 (minutes, used if dynamic_interval is true)
    compression_level: 1               # optional, default: 3
    compression_threads: 0             # optional, default: 0 (auto)

---

3. Target Fields Explained

• name: Unique identifier for the target directory.
• path: Absolute path to the directory you want to move to RAM.
• backup_path: Optional path where backups will be stored.
• max_backups: Maximum number of backup files to keep. Older backups are deleted automatically.
• interval: Backup interval in minutes.
• dynamic_interval: Set to true to adjust backup interval based on file changes.
• max_dynamic_interval: Maximum interval for dynamic backup (in minutes).
• compression_level: Zstandard compression level (1–22).
• compression_threads: Number of threads for Zstandard compression (0 = automatic).

---

4. Example: Multiple Targets

targets:
  - name: project_a
    path: /home/user/project_a
    max_backups: 5
    interval: 20
  - name: project_b
    path: /home/user/project_b
    dynamic_interval: true
    max_dynamic_interval: 60

---

5. Notes

• Make sure all paths exist and are directories.
• RAMifier will create backup directories automatically if they don’t exist.
• For optimal performance, store frequently accessed or small directories in RAM.