Add quick configuration guide
This commit is contained in:
parent
21e80ab883
commit
2004951738
|
|
@ -0,0 +1,218 @@
|
||||||
|
# ⚡ Quick Configuration Guide
|
||||||
|
|
||||||
|
Your Homarr is running! Let's set it up in ~10 minutes.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 1️⃣ Initial Setup
|
||||||
|
|
||||||
|
### Access Onboarding
|
||||||
|
- Open: `http://YOUR-SERVER-IP:7575`
|
||||||
|
- Create admin account (this user has full control)
|
||||||
|
- Complete the onboarding wizard
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 2️⃣ Create Boards
|
||||||
|
|
||||||
|
Go to **Manage → Boards → New Board**
|
||||||
|
|
||||||
|
### Board 1: Main Dashboard (Public)
|
||||||
|
```
|
||||||
|
Name: Main Dashboard
|
||||||
|
Visibility: Public (accessible without login)
|
||||||
|
```
|
||||||
|
|
||||||
|
**Add Widgets:**
|
||||||
|
1. **Clock** → Large, show date
|
||||||
|
2. **Weather** → Enter your location
|
||||||
|
3. **RSS Feed** (Homelab):
|
||||||
|
- Name: "Homelab News"
|
||||||
|
- URLs: `https://selfh.st/rss/,https://noted.lol/rss/`
|
||||||
|
- Posts limit: 10
|
||||||
|
4. **RSS Feed** (Cyber):
|
||||||
|
- Name: "Cybersecurity"
|
||||||
|
- URLs: `https://www.bleepingcomputer.com/feed/,https://krebsonsecurity.com/feed/`
|
||||||
|
5. **RSS Feed** (Tech):
|
||||||
|
- Name: "Tech News"
|
||||||
|
- URLs: `https://news.ycombinator.com/rss,https://techcrunch.com/feed/`
|
||||||
|
|
||||||
|
**Add Apps:**
|
||||||
|
- Gmail, GitHub, Reddit, YouTube
|
||||||
|
- Proxmox, Portainer, Plex
|
||||||
|
|
||||||
|
### Board 2: Infrastructure (Private)
|
||||||
|
```
|
||||||
|
Name: Infrastructure
|
||||||
|
Visibility: Private (login required)
|
||||||
|
```
|
||||||
|
|
||||||
|
**Add Widgets:**
|
||||||
|
1. **iFrame** → URL: `http://YOUR-SERVER-IP:3001` (full width)
|
||||||
|
2. **System Health Monitor** (if you have Proxmox)
|
||||||
|
3. **DNS Hole** (if you have Pi-hole/AdGuard)
|
||||||
|
|
||||||
|
**Add Apps:**
|
||||||
|
- Proxmox, Portainer, TrueNAS
|
||||||
|
- Grafana, Uptime Kuma
|
||||||
|
- Pi-hole, AdGuard
|
||||||
|
|
||||||
|
### Board 3: System Overview (Private)
|
||||||
|
```
|
||||||
|
Name: System
|
||||||
|
Visibility: Private
|
||||||
|
Layout: Full width
|
||||||
|
```
|
||||||
|
|
||||||
|
**Add Widget:**
|
||||||
|
1. **iFrame** → `http://YOUR-SERVER-IP:3001` (fullscreen)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 3️⃣ Add Apps (Quick Method)
|
||||||
|
|
||||||
|
Go to **Manage → Apps → New App**
|
||||||
|
|
||||||
|
### Example Apps to Add:
|
||||||
|
|
||||||
|
| Name | Icon | URL |
|
||||||
|
|------|------|-----|
|
||||||
|
| Proxmox | `proxmox` | `https://proxmox.lemonlink.eu` |
|
||||||
|
| Portainer | `portainer` | `https://portainer.lemonlink.eu` |
|
||||||
|
| Plex | `plex` | `https://plex.lemonlink.eu` |
|
||||||
|
| Nextcloud | `nextcloud` | `https://cloud.lemonlink.eu` |
|
||||||
|
| GitHub | `github` | `https://github.com` |
|
||||||
|
| Reddit | `reddit` | `https://reddit.com` |
|
||||||
|
|
||||||
|
**Tip:** Type icon name in the icon field - Homarr has 11,000+ icons!
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 4️⃣ Theme Customization
|
||||||
|
|
||||||
|
Go to **Board Settings → Appearance**
|
||||||
|
|
||||||
|
### Dark Theme (lemonlink.eu style):
|
||||||
|
```
|
||||||
|
Primary Color: #6366f1 (Indigo)
|
||||||
|
Secondary Color: #8b5cf6 (Purple)
|
||||||
|
Background: #0a0a0f (Near black)
|
||||||
|
Text Color: #e2e8f0
|
||||||
|
```
|
||||||
|
|
||||||
|
### Custom CSS (Board Settings):
|
||||||
|
```css
|
||||||
|
/* Glassmorphism cards */
|
||||||
|
.homarr-card {
|
||||||
|
background: rgba(255, 255, 255, 0.05) !important;
|
||||||
|
backdrop-filter: blur(10px) !important;
|
||||||
|
border: 1px solid rgba(255, 255, 255, 0.1) !important;
|
||||||
|
border-radius: 16px !important;
|
||||||
|
}
|
||||||
|
|
||||||
|
.homarr-card:hover {
|
||||||
|
transform: translateY(-4px) !important;
|
||||||
|
box-shadow: 0 20px 40px rgba(0, 0, 0, 0.3) !important;
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 5️⃣ Integrations
|
||||||
|
|
||||||
|
Go to **Manage → Integrations**
|
||||||
|
|
||||||
|
### Dash. (System Monitor)
|
||||||
|
Already integrated! Just add iFrame widget with `http://YOUR-SERVER-IP:3001`
|
||||||
|
|
||||||
|
### Docker
|
||||||
|
1. Click **New Integration**
|
||||||
|
2. Type: Docker
|
||||||
|
3. Name: "Local Docker"
|
||||||
|
4. Save
|
||||||
|
|
||||||
|
### Proxmox (Optional)
|
||||||
|
1. New Integration → Proxmox
|
||||||
|
2. Host: `https://proxmox.lemonlink.eu`
|
||||||
|
3. Token ID & Secret from Proxmox
|
||||||
|
4. Save
|
||||||
|
|
||||||
|
### Media Servers (Optional)
|
||||||
|
1. New Integration → Plex/Jellyfin
|
||||||
|
2. Enter API key/URL
|
||||||
|
3. Test connection
|
||||||
|
4. Save
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 6️⃣ Access Control
|
||||||
|
|
||||||
|
### Public vs Private
|
||||||
|
|
||||||
|
| Board | Visibility | Who Can See |
|
||||||
|
|-------|------------|-------------|
|
||||||
|
| Main Dashboard | Public | Everyone |
|
||||||
|
| News Hub | Public | Everyone |
|
||||||
|
| Infrastructure | Private | Logged-in users |
|
||||||
|
| Media Center | Private | Logged-in users |
|
||||||
|
| System | Private | Logged-in users |
|
||||||
|
|
||||||
|
Change visibility: **Board Settings → Visibility**
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 7️⃣ RSS Feed URLs
|
||||||
|
|
||||||
|
From `config/rss-feeds.json`:
|
||||||
|
|
||||||
|
### Homelab
|
||||||
|
```
|
||||||
|
https://selfh.st/rss/
|
||||||
|
https://noted.lol/rss/
|
||||||
|
https://feeds.fireside.fm/selfhosted/rss
|
||||||
|
```
|
||||||
|
|
||||||
|
### Cybersecurity
|
||||||
|
```
|
||||||
|
https://www.bleepingcomputer.com/feed/
|
||||||
|
https://feeds.feedburner.com/TheHackersNews
|
||||||
|
https://krebsonsecurity.com/feed/
|
||||||
|
```
|
||||||
|
|
||||||
|
### Technology
|
||||||
|
```
|
||||||
|
https://news.ycombinator.com/rss
|
||||||
|
https://techcrunch.com/feed/
|
||||||
|
https://feeds.arstechnica.com/arstechnica/index
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## ✅ Quick Checklist
|
||||||
|
|
||||||
|
- [ ] Create admin account
|
||||||
|
- [ ] Create 3-5 boards
|
||||||
|
- [ ] Add 10-20 apps
|
||||||
|
- [ ] Add Clock + Weather widgets
|
||||||
|
- [ ] Add 3 RSS feed widgets
|
||||||
|
- [ ] Add Dash. iFrame to infrastructure board
|
||||||
|
- [ ] Set dark theme colors
|
||||||
|
- [ ] Configure public/private boards
|
||||||
|
- [ ] Test external access via NPM
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🎯 Pro Tips
|
||||||
|
|
||||||
|
1. **Drag & Drop**: Move apps/widgets by dragging
|
||||||
|
2. **Resize**: Use corner handles on widgets
|
||||||
|
3. **Search**: Use the search bar for quick access
|
||||||
|
4. **Edit Mode**: Click pencil icon to edit board
|
||||||
|
5. **Icons**: Type app name in icon field - auto-suggests
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🆘 Need Help?
|
||||||
|
|
||||||
|
- **Homarr Docs**: https://homarr.dev/docs/
|
||||||
|
- **Your Repo**: https://git.lemonlink.eu/impulsivefps/homarr-dashboard
|
||||||
Loading…
Reference in New Issue