Skip to content

Commit 9b4284d

Browse files
committed
fix: update repository links to point to the correct melodee-project URLs
1 parent f33ce5c commit 9b4284d

File tree

10 files changed

+438
-110
lines changed

10 files changed

+438
-110
lines changed

Dockerfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,6 @@ HEALTHCHECK --interval=30s --timeout=5s --start-period=60s --retries=3 \
9393
CMD curl -fsS http://localhost:8080/health || exit 1
9494

9595
# OCI Labels
96-
LABEL org.opencontainers.image.source="https://github.com/sphildreth/melodee"
96+
LABEL org.opencontainers.image.source="https://github.com/melodee-project/melodee"
9797
LABEL org.opencontainers.image.description="Melodee music server"
9898
LABEL org.opencontainers.image.licenses="MIT"

README.md

Lines changed: 7 additions & 83 deletions
Original file line numberDiff line numberDiff line change
@@ -121,105 +121,29 @@ Before installing, test drive Melodee on our demo server:
121121

122122
👉 **[https://demo.melodee.org](https://demo.melodee.org)** (Username: `demo`, Password: `Mel0deeR0cks!`)
123123

124-
### Prerequisites
125-
126-
- [Podman](https://podman.io/) or Docker
127-
- [Podman Compose](https://github.com/containers/podman-compose) (for Podman users)
128-
- Python 3 (for setup script)
129-
130-
### 🐍 Automated Setup (Recommended)
124+
### Automated Setup (Recommended)
131125

132126
```bash
133-
# Clone the repository
134-
git clone https://github.com/sphildreth/melodee.git
127+
git clone https://github.com/melodee-project/melodee.git
135128
cd melodee
136-
137-
# Run the setup script with auto-start
138129
python3 scripts/run-container-setup.py --start
139130
```
140131

141-
The script will:
142-
- Run preflight checks (disk space, memory, ports, required files)
143-
- Detect your container runtime (Podman or Docker)
144-
- Generate a secure `.env` file with random passwords and JWT tokens
145-
- Build the container image
146-
- Start the containers and wait for health checks
147-
- Provide you with the URL to access Melodee
148-
149-
#### Setup Script Options
150-
151-
```bash
152-
python3 scripts/run-container-setup.py --check-only # Just run checks
153-
python3 scripts/run-container-setup.py --start # Setup and start containers
154-
python3 scripts/run-container-setup.py --update # Update existing deployment
155-
python3 scripts/run-container-setup.py --update -y # Update without prompts (CI/CD)
156-
```
157-
158-
### 🐳 Manual Deploy with Podman
132+
The script handles preflight checks, runtime detection, secure configuration, building, and startup.
159133

160-
1. **Clone the repository**
161-
```bash
162-
git clone https://github.com/sphildreth/melodee.git
163-
cd melodee
164-
```
165-
166-
2. **Configure environment variables**
167-
```bash
168-
# Copy and edit the example environment file
169-
cp example.env .env
170-
nano .env
171-
```
172-
173-
Update the following variables in `.env`:
174-
```bash
175-
# Database password (change this!)
176-
DB_PASSWORD=your_secure_password_here
177-
178-
# Port configuration
179-
MELODEE_PORT=8080
180-
```
181-
182-
3. **Build and deploy**
183-
```bash
184-
# Using Podman (build first, then start)
185-
podman compose build
186-
podman compose up -d
187-
188-
# Or using Docker Compose
189-
docker compose up -d --build
190-
```
191-
192-
4. **Access the application**
193-
- 📚 Read the [documentation](https://melodee.org) on how to get started
194-
- Web Interface: http://localhost:8080
195-
- Register as a new user, the first user will be setup as administrator
196-
- Configure clients to connect to your server
197-
- Enjoy an ad-free and self-hosted music streaming service 🎉
134+
📖 **Full installation guide**: [melodee.org/installing](https://melodee.org/installing/)
198135

199136
### 📦 Updating Melodee
200137

201-
The safest way to update is using the setup script:
202-
203138
```bash
204139
cd melodee
205140
git pull
206141
python3 scripts/run-container-setup.py --update
207142
```
208143

209-
This preserves all your data volumes while updating the application code. For automated/CI deployments:
210-
211-
```bash
212-
git pull && python3 scripts/run-container-setup.py --update --yes
213-
```
214-
215-
**Manual update:**
216-
```bash
217-
git pull origin main
218-
podman compose build # Rebuild with new code
219-
podman compose up -d # Recreate containers (volumes preserved)
220-
```
144+
Your data (database, music library, playlists) is preserved during updates. Database migrations run automatically.
221145

222-
> **Note**: Database migrations run automatically during container startup. Your data (database, music library, playlists) is preserved during updates.
146+
📖 **Full upgrade guide**: [melodee.org/upgrade](https://melodee.org/upgrade/)
223147

224148
## 🏠 Homelab Deployment
225149

@@ -230,7 +154,7 @@ Melodee is designed to run in homelab environments with support for various hard
230154
- **NAS Integration**: Mount external storage for large music collections
231155
- **Container Orchestration**: Docker Compose, Podman Compose, or Docker Swarm
232156

233-
For detailed homelab deployment guides, check out our [documentation](https://melodee.org).
157+
📖 **Deployment guides**: [melodee.org/installing](https://melodee.org/installing/) | [melodee.org/upgrade](https://melodee.org/upgrade/)
234158

235159
### 🗂️ Volume Management
236160

design/backlog/onboarding-backlog.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -216,7 +216,7 @@ Publish pre-built images to GitHub Container Registry so users can pull instead
216216
**Proposed Usage**:
217217
```bash
218218
# Instead of building locally
219-
podman pull ghcr.io/sphildreth/melodee:latest
219+
podman pull ghcr.io/melodee-project/melodee:latest
220220
podman compose up -d
221221
```
222222

@@ -232,7 +232,7 @@ podman compose up -d
232232
- Manual dispatch for testing
233233

234234
**Acceptance Criteria**:
235-
- [ ] Images published to ghcr.io/sphildreth/melodee
235+
- [ ] Images published to ghcr.io/melodee-project/melodee
236236
- [ ] amd64 and arm64 architectures supported
237237
- [ ] compose.yml updated to pull from GHCR
238238
- [ ] Local build still works as fallback

docs/_data/toc.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@
1414
links:
1515
- title: "Homelab Deployment"
1616
url: "homelab"
17+
- title: "Upgrade Guide"
18+
url: "upgrade"
1719
- title: "Hardware & Performance"
1820
url: "hardware"
1921
- title: "Backup & Recovery"
Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
---
2+
title: "Melodee 1.8.0 Released"
3+
date: 2026-01-12
4+
badges:
5+
- type: info
6+
tag: release
7+
---
8+
9+
We're excited to announce the release of Melodee 1.8.0, packed with new features for an enhanced music streaming experience!
10+
11+
<!--more-->
12+
13+
## What's New in 1.8.0
14+
15+
### Party Mode
16+
Collaborative listening sessions with shared queues and synchronized playback control. Perfect for gatherings or remote listening parties with friends and family.
17+
18+
- Create and manage party sessions
19+
- Shared queue management
20+
- Real-time playback synchronization
21+
- Participant roles and permissions
22+
23+
### Jukebox Mode
24+
Server-side audio playback via MPV or MPD backends, enabling whole-home audio setups.
25+
26+
- Control playback from any device
27+
- Support for MPV and MPD audio backends
28+
- Ideal for dedicated audio endpoints
29+
30+
### Podcast Support
31+
Full podcast subscription and playback support with tracking.
32+
33+
- Subscribe to podcasts via RSS or OPML import
34+
- Automatic episode downloads
35+
- Playback position tracking
36+
- Integration with OpenSubsonic podcast APIs
37+
38+
### Custom Theming
39+
Personalize Melodee's appearance with custom themes.
40+
41+
- Create custom color schemes
42+
- Custom fonts and branding
43+
- Hide/show navigation items
44+
- Theme pack import/export
45+
46+
### Music Charts
47+
Curated album charts updated automatically.
48+
49+
- Billboard chart integration
50+
- Multiple chart sources
51+
- Automatic updates via background jobs
52+
53+
### Additional Improvements
54+
55+
- **Jellyfin API compatibility** - Use Jellyfin clients with Melodee
56+
- **Deezer search engine** - Additional metadata source
57+
- **Enhanced scrobbling** - Improved Last.fm integration
58+
- **Performance improvements** - Faster library scanning and streaming
59+
60+
## Upgrading
61+
62+
To upgrade to 1.8.0, follow the [upgrade guide](/docs/upgrading/).
63+
64+
Database migrations will run automatically on startup.
65+
66+
## Documentation
67+
68+
- [Party Mode Guide](/party-mode/)
69+
- [Jukebox Setup](/jukebox/)
70+
- [Podcast Configuration](/podcasts/)
71+
- [Theming Guide](/theming/)
72+
- [Charts Configuration](/charts/)
73+
74+
## Thank You
75+
76+
Thanks to everyone who contributed to this release through bug reports, feature requests, and pull requests!
77+
78+
Questions or feedback? Join our [Discord community](https://discord.gg/bfMnEUrvbp) or open an issue on [GitHub](https://github.com/melodee-project/melodee/issues).

docs/index.markdown

Lines changed: 30 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,16 @@ New to Melodee? Start with our [Quick Start Guide for Homelabs](/quickstart/) to
1616
## Key Features
1717

1818
- **Scalable Architecture**: Handle millions of tracks with efficient background processing
19-
- **Dual API Support**: OpenSubsonic compatibility and native REST API
19+
- **Multi-API Support**: OpenSubsonic, Jellyfin, and native REST API compatibility
2020
- **Advanced Media Processing**: Automatic format conversion, metadata normalization, and validation
2121
- **Staging Workflow**: Review and edit metadata before publishing to your library
22-
- **Multiple Client Support**: Compatible with popular Subsonic clients plus official desktop and mobile apps
22+
- **Party Mode**: Collaborative listening sessions with shared queues and playback control
23+
- **Jukebox Mode**: Server-side audio playback via MPV/MPD for whole-home audio
24+
- **Podcast Support**: Subscribe, download, and stream podcasts with full playback tracking
25+
- **Custom Theming**: Personalize the UI with custom color schemes, fonts, and branding
26+
- **Music Charts**: Curated album charts updated automatically from Billboard and other sources
27+
- **Scrobbling**: Last.fm integration for play history tracking
28+
- **Multiple Client Support**: Compatible with popular Subsonic/Jellyfin clients
2329

2430
## Homelab Focus
2531

@@ -31,15 +37,35 @@ Melodee is designed with homelab enthusiasts in mind:
3137

3238
## Documentation Sections
3339

40+
### Getting Started
3441
- [Quick Start for Homelabs](/quickstart/) - Fast path to your first deployment
3542
- [Installation](/installing/) - Detailed setup instructions
3643
- [Configuration](/configuration/) - Tuning and optimization
3744
- [Configuration Reference](/configuration-reference/) - Comprehensive configuration options
38-
- [API Overview](/apis/) - Comparison of API options and interactive documentation
45+
46+
### Features
47+
- [Libraries](/libraries/) - Managing your music collection
48+
- [Charts](/charts/) - Curated album charts
49+
- [Playlists](/playlists/) - Creating and managing playlists
50+
- [Jukebox](/jukebox/) - Server-side audio playback
51+
- [Party Mode](/party-mode/) - Collaborative listening sessions
52+
- [Podcasts](/podcasts/) - Podcast subscription and playback
53+
- [Theming](/theming/) - Customize the UI appearance
54+
- [Requests](/requests/) - User music requests
55+
- [Scrobbling](/scrobbling/) - Last.fm integration
56+
- [Shares](/shares/) - Sharing music with others
57+
- [Query Language (MQL)](/mql/) - Advanced search queries
58+
59+
### Deployment & Operations
3960
- [Homelab Deployment](/homelab/) - Homelab-specific guidance
4061
- [Hardware & Performance](/hardware/) - Hardware recommendations and optimization
4162
- [Backup & Recovery](/backup/) - Data protection strategies
42-
- [API Documentation](/api/) - Native API reference
63+
- [Background Jobs](/jobs/) - Scheduled task management
64+
- [Command Line Interface](/cli/) - CLI tools and utilities
65+
66+
### API & Integration
67+
- [API Overview](/apis/) - Comparison of API options
68+
- [API Documentation](/api/) - Native REST API reference
4369

4470
## Community
4571

docs/pages/index.md

Lines changed: 23 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -33,18 +33,23 @@ This server has sample permissively licensed music files for testing purposes. T
3333

3434
## Feature Highlights
3535

36-
- Media normalization & configurable tag rewrite rules.
37-
- Regex driven cleanup (featuring/with removal, numbering fixes, stray tokens).
38-
- Multi‑stage pipeline (Inbound ➜ Staging ➜ Storage).
39-
- Pluggable metadata & artwork fetch (MusicBrainz local cache, Last.FM, Spotify, iTunes).
40-
- Real‑time transcoding (MP3, Ogg, Opus, etc.) with range & partial streaming.
41-
- Cron‑like job scheduler (scans, enrichment, cleanup, background sync).
42-
- Multi‑library federation (spread storage across NAS / mounts).
43-
- Blazor Server UI for metadata, artwork, users, config & monitoring.
44-
- OpenSubsonic compatibility (tested against several popular clients).
45-
- Native REST API (versioned) for custom integrations.
46-
- User features: starring, ratings, scrobbling, play tracking.
47-
- Concurrency‑aware streaming limiter & optional buffered responses.
36+
- Media normalization & configurable tag rewrite rules
37+
- Regex driven cleanup (featuring/with removal, numbering fixes, stray tokens)
38+
- Multi‑stage pipeline (Inbound ➜ Staging ➜ Storage)
39+
- Pluggable metadata & artwork fetch (MusicBrainz local cache, Last.FM, Spotify, iTunes, Deezer)
40+
- Real‑time transcoding (MP3, Ogg, Opus, etc.) with range & partial streaming
41+
- Cron‑like job scheduler (scans, enrichment, cleanup, background sync)
42+
- Multi‑library federation (spread storage across NAS / mounts)
43+
- Blazor Server UI for metadata, artwork, users, config & monitoring
44+
- [Party Mode](/party-mode/) - Collaborative listening with shared queues
45+
- [Jukebox](/jukebox/) - Server-side audio playback via MPV/MPD
46+
- [Podcasts](/podcasts/) - Subscribe, download, and stream podcasts
47+
- [Custom Theming](/theming/) - Personalize colors, fonts, and branding
48+
- [Music Charts](/charts/) - Curated album charts from Billboard and more
49+
- [Scrobbling](/scrobbling/) - Last.fm integration for play tracking
50+
- OpenSubsonic & Jellyfin API compatibility
51+
- Native REST API (versioned) for custom integrations
52+
- User features: starring, ratings, playlists, play history
4853

4954
## Tested OpenSubsonic Clients
5055

@@ -58,12 +63,12 @@ This server has sample permissively licensed music files for testing purposes. T
5863

5964
## Quick Links
6065

61-
- Installation: /installing/
62-
- Configuration: /configuration/
63-
- Libraries Concept: /libraries/
64-
- API Reference (OpenSubsonic + Native): /api/
65-
- Changelog / News: /news/
66-
- About & Project Direction: /about/
66+
- [Installation](/installing/) - Get Melodee up and running
67+
- [Configuration](/configuration/) - Tune settings for your environment
68+
- [Libraries](/libraries/) - Understand the library concept
69+
- [API Reference](/api/) - OpenSubsonic + Native API documentation
70+
- [News](/news/) - Changelog and announcements
71+
- [About](/about/) - Project direction and philosophy
6772

6873
## Contributing
6974

docs/pages/theming.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Custom themes allow you to personalize Melodee's appearance beyond the built-in
3030

3131
### Available Custom Themes
3232

33-
Pre-built custom theme packs are available in the [Melodee repository's `/themes` directory](https://github.com/sphildreth/melodee/tree/main/themes):
33+
Pre-built custom theme packs are available in the [Melodee repository's `/themes` directory](https://github.com/melodee-project/melodee/tree/main/themes):
3434

3535
| Theme | Base | Description |
3636
|-------|------|-------------|

0 commit comments

Comments
 (0)