cabi24/notenregal repository overview

Notenregal

A beautiful Victorian-themed sheet music library for organizing, viewing, and annotating your PDF sheet music collection.

Features

• PDF Viewer with smooth page navigation
• Annotation Tools - pen, highlighter, and musical stamps (fermata, accents, dynamics)
• Regalpaket Format - convert PDFs to optimized image format for instant page turns
• Shelf Organization - create custom shelves to categorize your music
• Favorites - mark songs with a star for quick access
• Search & Sort - find music by name, sort by date or type
• Grid & List Views - see full titles in list view
• Mobile Friendly - touch gestures for page turning
• Password Protected - simple authentication to protect your library

Quick Start

docker run -d
--name notenregal
--restart unless-stopped
-p 3001:3001
-v /path/to/your/music:/library
-v notenregal-data:/data
cabi24/notenregal

Then open http://localhost:3001⁠ and set your password.

Docker Compose

services: notenregal: image: cabi24/notenregal:latest container_name: notenregal restart: unless-stopped ports: - "3001:3001" environment: - PORT=3001 - DATA_PATH=/data - LIBRARY_PATH=/library volumes: - /path/to/your/music:/library - notenregal-data:/data

volumes: notenregal-data:

Environment Variables

Volumes

Supported Architectures

Multi-arch images are built automatically. Works on:

• Standard Linux/Windows servers
• Raspberry Pi 4/5 (64-bit OS)
• Apple Silicon Macs

Ports

Adding Sheet Music

1. Place PDF files in your mounted library directory
2. Refresh the browser - new files appear automatically
3. Right-click files to organize into shelves or mark as favorites

Regalpaket Format

Convert PDFs to Regalpaket (.regal) for faster page turns:

1. Open any PDF in the viewer
2. Click "Make Regalpaket" button
3. Pages are pre-rendered as images for instant display

Regalpakets are ideal for performance use where quick page turns matter.

Backup & Restore

Backup your data: docker run --rm
-v notenregal-data:/data
-v $(pwd):/backup
alpine tar czf /backup/notenregal-backup.tar.gz /data

Restore from backup: docker run --rm
-v notenregal-data:/data
-v $(pwd):/backup
alpine tar xzf /backup/notenregal-backup.tar.gz -C /

Updating

docker pull cabi24/notenregal:latest docker stop notenregal docker rm notenregal

⁠Run your docker run command again

Or with Docker Compose: docker compose pull docker compose up -d

Source Code

https://github.com/cabi24/notenregal⁠

Tags

• latest - Latest stable release
• main - Latest build from main branch
• x.x.x - Specific version releases