# Sun-Panel — Beautiful Self-Hosted Server Dashboard

> A visually polished server homepage and dashboard with custom icons, multi-user support, and Docker integration.

## Install

Save in your project root:

# Sun-Panel — Beautiful Self-Hosted Server Dashboard

## Quick Use
```bash
docker run -d --name sun-panel 
  -p 3002:3002 
  -v /var/sun-panel:/app/conf 
  hslr/sun-panel
```

## Introduction
Sun-Panel is a self-hosted server dashboard designed as a personal homepage for your services and bookmarks. It provides a clean, icon-rich interface where you can organize links to all your self-hosted applications, monitor system status, and manage access for multiple users from a single page.

## What Sun-Panel Does
- Displays a customizable grid of service links with icons and descriptions
- Supports multi-user accounts with individual bookmark collections
- Integrates with Docker to auto-discover running containers
- Provides a built-in icon library and support for custom uploaded icons
- Offers a search bar for quickly navigating between configured services

## Architecture Overview
Sun-Panel is built with a Go backend and a Vue.js frontend. It stores configuration and user data in an embedded SQLite database. The Docker integration communicates with the Docker socket to list running containers. The application is distributed as a single Docker image or standalone binary with minimal resource requirements.

## Self-Hosting & Configuration
- Deploy via Docker with a single volume mount for persistent configuration
- Access the web UI on port 3002 and create an admin account on first launch
- Add service links manually or enable Docker socket access for auto-discovery
- Customize the layout with icon packs, background images, and color themes
- Create additional user accounts for family members or team members

## Key Features
- Polished UI with smooth animations and responsive design for mobile access
- Multi-user support with per-user bookmark collections and preferences
- Built-in icon picker with thousands of icons from popular icon sets
- Docker container auto-discovery via socket integration
- Lightweight footprint suitable for Raspberry Pi and low-power devices

## Comparison with Similar Tools
- **Homepage** — YAML-configured with service widgets; Sun-Panel uses a visual editor for easier setup
- **Dashy** — feature-rich with many widgets; Sun-Panel focuses on visual simplicity
- **Homer** — static YAML dashboard; Sun-Panel adds multi-user and Docker integration
- **Flame** — minimalist bookmark dashboard; Sun-Panel offers richer customization and user management

## FAQ
**Q: Does Sun-Panel monitor service uptime?**
A: Sun-Panel focuses on organizing and displaying service links. For uptime monitoring, pair it with a tool like Uptime Kuma.

**Q: Can I use it on a Raspberry Pi?**
A: Yes. Sun-Panel has low resource requirements and runs well on ARM-based devices.

**Q: How do I back up my configuration?**
A: Back up the mounted `/app/conf` volume which contains the SQLite database and uploaded assets.

**Q: Is there an API?**
A: Sun-Panel provides a REST API for programmatic management of links and users.

## Sources
- https://github.com/hslr-s/sun-panel
- https://sun-panel.top

---
Source: https://tokrepo.com/en/workflows/asset-5a91dd31
Author: AI Open Source