Skip to main content

Homarr Upgrade to 1.0

This episode updates episodes 13 & 14 due to Homarr's source code rewrite.

What we will cover

!

Important

This episode is good for FRESH INSTALLS AND those UPGRADING from the old Homarr Dashboard

  1. Creating a new VM for the new Homarr Dashboard
  2. How to create an API key for Proxmox usage stats
  3. How to install the new 1.0 Homarr dashboard
  4. How to upgrade from the old dashboard to the new dashboard
  5. How to add trusted certificates to your dashboard
  6. How to edit old Proxmox integrations
  7. How to create new Proxmox integrations in the Homarr Dashboard

Getting started

Fresh Install Users

Create a new Ubuntu Server VM in Proxmox with:

  1. OS: Ubuntu Server
  2. 2GB RAM
  3. 2 vcores
  4. 32GB storage
Ubuntu Server VM creation

During install, ensure SSH is enabled!

Enabling SSH during install

SSH into your new Homarr VM:

ssh <username>@<VM_ipaddress>
SSH into Homarr VM

Add Docker's GPG keys and repo:

# Add Docker's official GPG key:
sudo apt-get update
sudo apt-get install ca-certificates curl
sudo install -m 0755 -d /etc/apt/keyrings
sudo curl -fsSL https://download.docker.com/linux/ubuntu/gpg -o /etc/apt/keyrings/docker.asc
sudo chmod a+r /etc/apt/keyrings/docker.asc

# Add the repository to Apt sources:
echo \
"deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/ubuntu \
$(lsb_release -cs) stable" | \
sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
sudo apt-get update
Docker repo added

Install Docker:

sudo apt-get install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin
Docker installation

Verify Docker is running:

sudo docker run hello-world
Docker test successful
If Docker hello-world fails, try this

Check Docker service:

systemctl status docker.service

If failed, reload and restart:

sudo systemctl daemon-reload
sudo systemctl restart docker

Recheck status:

systemctl status docker.service
Docker status check

Install Docker Compose

sudo apt install docker-compose

Verify:

docker compose version

Install Homarr

Create docker-compose.yml:

nano docker-compose.yml
Create docker-compose file

Paste this config:

#---------------------------------------------------------------------#
# Homarr - A simple, yet powerful dashboard for your server. #
#---------------------------------------------------------------------#
services:
homarr:
container_name: homarr
image: ghcr.io/homarr-labs/homarr:latest
restart: unless-stopped
volumes:
- /var/run/docker.sock:/var/run/docker.sock # Optional, only if you want docker integration
- ./homarr/appdata:/appdata
environment:
- SECRET_ENCRYPTION_KEY=51564af476c9eecd2efb30ed980a4b2e768efb7a558676859e2e1fbd04ce15a0
ports:
- '7575:7575'

Exit nano with Ctrl+X, confirm save with Y, press Enter to confirm filename.

Save docker-compose file

Start Homarr:

sudo docker compose up -d
Start Homarr service

Access Homarr at:

ip_address:7575
Homarr login page

Creating a Proxmox API Key

  1. In Proxmox portal, click Datacenter
  2. Expand Permissions, click Groups
  3. Click Create
Create group
  1. Name the group (e.g., api-users)
Group name
  1. Under Permissions, select Add → Group Permission
Add group permission

Set:

  • Path: /
  • Group: your created group
  • Role: PVEAuditor
  • Propagate: checked
Group permission details
  1. Under Permissions, click Users
  2. Click Add:
  • User name: descriptive (e.g., api)
  • Realm: Proxmox VE authentication server
  • Password: create secure password
  • Confirm password: re-enter
  • Group: your created group
Add user form
  1. Under Permissions, click API Tokens
  2. Click Add:
  • User: user from above
  • Token ID: descriptive (e.g., homarr)
  • Privilege Separation: unchecked
Add API token
  1. Copy the Secret shown (only displayed once).
API token secret
  1. Back to Permissions, click Add → API Token Permission
Add API token permission

Set:

  • Path: /
  • API Token: select token created
  • Role: PVE Auditor
  • Propagate: checked
API token permission details

Adding your Certificate

From the Proxmox node running Homarr:

  1. Select node → Certificates
  2. Select pve-root-ca.pem
  3. Click View certificate
View certificate

Copy to notepad and save as certificate_name.crt.

Copy cert to notepad

Paste contents:

Paste certificate text

Save as .crt file:

Save certificate file

In Homarr dashboard:

Go to username bubble (top right) → Manage → Tools → Certificates → Add Certificate → Select saved .crt file → Add.

Manage certificates Add certificate

You should see the valid certificate listed.

Certificate added Valid certificate confirmation

Adding Proxmox Stats Integration

Create a new app before adding integrations:

Click New App.

New app creation
  1. Name it
  2. Search for Proxmox icon
  3. Enter Proxmox node IP (URL)
  4. Click Create
App details

Go to Integrations tab:

  1. New Integration
  2. Search and select Proxmox
Add Proxmox integration

This is the major change from the old Homarr panel.

Get the correct Proxmox details: username, token ID, API key, and realm.

Proxmox credentials

In Proxmox Data Center:

  1. Go to API Token to find username and token name
View API tokens

Fill username, token ID, and API key in Homarr integration form.

Fill Homarr integration form

Get realm from Datacenter → Realms; typically PVE.

View real realms

Test connection and connect.

Test Homarr integration connection

Return to main dashboard via Homarr logo (top left) or Boards → select your dashboard.

Edit dashboard with pencil icon (top right) — it will appear differently.

Edit dashboard

You will see your icons with three dots (top right) and dashboard becomes editable.

Click + icon (top right), select New Item.

Add new item

Select System Health Monitoring, then Add to Board.

Add system health monitoring

On dashboard, find new section, click three dots → Edit Item.

Edit dashboard item

Select the integration created and Save Changes.

Select integration for monitor

Proxmox stats now appear on your dashboard.

Dashboard with Proxmox stats
⚠️

Note

The fresh install tutorial is now over.

Upgrade path for old users

Create a new Homarr VM

(See Fresh Install users steps above)

Exporting your old dashboard

Login to your OLD Homarr Dashboard → username (top right) → Manage → Settings → Tools → Migrate to 1.0

Old dashboard migration

Select Export Data, copy your encryption key (save it).

Export data option

Allow browser download if blocked.

Allow download

On your new VM, click Import from Homarr before 1.0

Import old config

Upload the .zip, confirm import, continue.

Confirm import

Paste encryption key to unzip.

Enter encryption key

You may disable anonymous analytics.

Disable anonymous analytics

Choose Go to default-large board.

Select default dashboard board

Login with old credentials if prompted.

Login prompt

Under Configure Server-Wide Home Dashboard:

Select your old dashboard → click three dots → Set as Your Home Board.

Configure home dashboard Set home board

Your dashboard is restored!

Restored dashboard

Updating Homarr 1.0

Navigate to directory with docker-compose.yaml (use sudo or become superuser).

Stop Homarr:

docker compose down

Pull newest image:

docker compose pull

Start Homarr in detached mode:

docker compose up -d

Clean up old images (warning: removes unused images, not just Homarr):

docker image prune
Homarr update

Follow Us on Social Media

YouTube
Discord
Patreon
Reddit
Rumble