Skip to main content

Backup Guide (OpenMediaVault/Docker)

(OpenMediaVault/Docker)

This guide documents how to safely back up your Homarr instance running as a Docker container on OpenMediaVault.

🔧 Purpose

Backing up your Homarr configuration ensures that all your dashboard settings and app tiles can be restored after a system wipe, migration, or rebuild.

🔢 Assumptions

    Homarr container is deployed via Docker Compose

    Docker is installed and running

    Your Homarr folder resides in:

    



    /srv/dev-disk-by-uuid-b588f7eb-f98f-4e15-b964-25574b92227e/HELCONFIG/homarr
    

    - You want to store the backup in:
    

    /srv/dev-disk-by-uuid-b588f7eb-f98f-4e15-b964-25574b92227e/HELCONFIG/
    

    
---

## 🚀 Backup Process

### ✅ Step 1: Stop the Container
To ensure a consistent backup, stop the running Homarr container first:
```bash
sudo docker stop homarr
    

    

    ✅ Step 2: Install Zip (if needed)
    

    If you haven't used the zip command before, you might need to install it:
    

    sudo apt update
sudo apt install zip -y
    

    

    ✅ Step 3: Create the Backup
    

    Run this command to zip the entire Homarr folder:
    

    sudo zip -r /srv/dev-disk-by-uuid-b588f7eb-f98f-4e15-b964-25574b92227e/HELCONFIG/homarr-full-backup.zip \
  /srv/dev-disk-by-uuid-b588f7eb-f98f-4e15-b964-25574b92227e/HELCONFIG/homarr
    

    

    ⚠️ Ensure you're zipping the entire folder, not just the appdata directory.
    

    

    

    ✅ Step 4: Start Homarr Again
    

    Once the backup is complete, start your container again:
    

    sudo docker start homarr
    

    

    📁 Result
    

    You will now have a backup file:
    

    homarr-full-backup.zip
    

    Located in:
    

    /srv/dev-disk-by-uuid-b588f7eb-f98f-4e15-b964-25574b92227e/HELCONFIG/
    

    This file contains everything inside your Homarr directory.
    

    

    ✉️ Notes
    

      


      The same process can be used to back up other containers by replacing the folder and container name.
      



      You can also schedule this with cron for automatic backups.
      



      

      🔄 To Restore
      

      To restore a backup:
      

      sudo unzip homarr-full-backup.zip -d /srv/dev-disk-by-uuid-b588f7eb-f98f-4e15-b964-25574b92227e/HELCONFIG/
      

      Then bring the container up with Docker Compose as usual.
      

       
      
    
              
      
    
      

            
      
        
      
    
      

    
      

    
    
      
        
      
             Back to top