An open API service indexing awesome lists of open source software.

https://github.com/tanq16/raikiri

No nonsense self hosted media and music server
https://github.com/tanq16/raikiri

catppuccin docker go golang hls homelab image jellyfin-alternative markdown-renderer media media-server music music-player music-server self-hosted selfhosted spotify-alternative streaming tailwindcss video

Last synced: 2 months ago
JSON representation

No nonsense self hosted media and music server

Awesome Lists containing this project

README

          


Local Content Share Logo

Raikiri

Build Workflow GitHub Release Docker Pulls

FeaturesScreenshotsUsageThumbnailsPlayer

A fast, simple, self-hosted, no-nonsense media server. Lightweight alternative to Jellyfin/Plex without complex metadata tagging.

The aim is to provide an elegant directory listing for images, videos, and audio. It uses folder navigation and predictable thumbnail paths for cover art, thumbnails, etc. Other files are also available to browse and can be directly downloaded.

## Features

- Beautiful Catppuccin Mocha themed application for modern web-based directory listing
- Dual system with separate Media and Music modes, each with independent directory paths
- Music navigation is folder-first (Artist → Album → Tracks) with no extra pills
- Tracks in Music are always shown in list view without thumbnails
- Intelligent thumbnail system that displays previews when available, else fallback to icons
- Playlist queue automatically created from media (removable items) in current directory
- Player bar with expanded player view supporting audio, video, and image playback
- Image slideshow mode with automatic advancement every 5 seconds
- Shuffle mode for recursive directory playback (media files only)
- Queue dialog showing current playlist with ability to jump to any item
- Video history tracking - stores last 50 video paths in browser local storage
- Fullscreen player support for videos and images
- Subtitle support for videos with automatic detection of SRT files and embedded tracks
- Player with support to switch between multiple available subtitle tracks
- Search functionality to filter files in the current directory
- Ability to upload files to the server at specific paths
- Thumbnail generation mode in CLI for movies, shows, and videos (using `ffmpeg` and TMDB API)
- Automatic cache cleanup that removes old HLS session files older than 3 days
- Fully self-hosted with local assets and self-contained binary and container
- Efficient size for both binary and container, ~15 and ~50 MB resp

## Screenshots

| | | |
|:---:|:---:|:---:|
| | | |
| | | |
| | | |

## Usage

### Docker (for Homelab)

```bash
mkdir $HOME/raikiri # you don't need to create this if you already have media in a specific directory
```
```bash
docker run --rm -d --name raikiri \
-p 8080:8080 \
-v $HOME/raikiri:/app/media \
-v $HOME/music:/app/music \
-v $HOME/raikiri-cache:/app/cache \
tanq16/raikiri:main
```

Available at `http://localhost:8080`. Docker Compose example:

```yaml
services:
raikiri:
image: tanq16/raikiri:main
container_name: raikiri
volumes:
- /home/tanq/raikiri:/app/media # Change as needed
- /home/tanq/music:/app/music # Change as needed
- /home/tanq/raikiri-cache:/app/cache # HLS segment cache
ports:
- 8080:8080
```

### Binary

To use the binary, simply download the latest version from the project releases and run as follows:

```bash
raikiri serve --media $YOUR_MEDIA_FOLDER --music $YOUR_MUSIC_FOLDER --cache $YOUR_HLS_CACHE_FOLDER
```

Flags:
- `--media`: media directory path (default: `.`)
- `--music`: music directory path (default: `./music`)
- `--cache`: HLS cache directory (default: `/tmp`)
- `--port`: port to listen on (default: `8080`)
- `--version`: print version information

Switch between Media and Music modes via interface tabs. Think of it as your own minimal Netflix on the Media tab and your own minimal Spotify on the Music tab.

Cache directory stores temporary HLS segments generated during video playback. Auto-cleanup runs daily at 3 AM, removing sessions older than 3 days.

Storing cache in your SSD will yield faster performance (or instant seeks anywhere in the video). However, using HDD is recommended for longevity (lots of segment writes), even though it's not instant when seeking to further ahead right after launching the video.

### Local Development

Install with Go 1.25+:

```bash
go install github.com/tanq16/raikiri@latest
```

Or build from source:

```bash
git clone https://github.com/tanq16/raikiri.git && \
cd raikiri && \
make build
```

### Additional Notes

#### Requirements

Requires `ffmpeg` (includes `ffprobe`) in PATH for:
- Video playback (HLS transmuxing; transcodes if audio is a mismatch)
- Thumbnail generation (`prepare` subcommand)

For Docker deployments, provided image includes `ffmpeg`.

#### Thumbnails

Thumbnails are stored as hidden files (`.filename.thumbnail.jpg`) alongside media. It is displayed in grid view when available.

To generate thumbnails, use the `prepare` subcommand:

- `thumbnails`: Generate ffmpeg thumbnails recursively for all videos in the current directory
- `thumbnails --current`: Generate thumbnails for the current directory only (non-recursive)
- `thumbnails `: Generate a thumbnail for a single video file
- `shows`: Auto-match TV shows using TMDB API (requires `TMDB_API_KEY` environment variable); run in the directory containing all show directories
- `shows --manual`: Interactive TV show matching for a single show directory
- `movies`: Auto-match movies using TMDB API (requires `TMDB_API_KEY` environment variable); run in the directory containing all movie directories
- `movies --manual`: Interactive movie matching for a single movie directory

```bash
raikiri prepare thumbnails
raikiri prepare thumbnails --current
raikiri prepare thumbnails path/to/video.mkv
raikiri prepare shows
raikiri prepare movies --manual
```

> [!NOTE]
> - Video thumbnails are screenshots at 50% of the video duration
> - For images, the original file is used as a fallback if no thumbnail exists

> [!TIP]
> In Music mode, album art is considered as the directory thumbnail (`.thumbnail.jpg`), artist cover is considered from artist directory thumbnail. Tracks use list view (no thumbnails).

#### Video Tools

The `video-info` and `video-encode` commands are standalone CLI tools for inspecting and re-encoding video files.

```bash
raikiri video-info path/to/video.mkv
raikiri video-encode path/to/video.mkv
raikiri video-encode --quality high path/to/video.mkv
raikiri video-encode --slower path/to/video.mkv
```

`video-info` displays a table with container info, video/audio/subtitle streams, codecs, resolution, frame rate, bitrate, and languages.

`video-encode` smart-encodes to H.265 with automatic stream selection:
- Selects the best audio stream (rejects commentary/descriptive tracks)
- Keeps all subtitle streams, picks MP4 or MKV container based on subtitle type
- Auto-halves high frame rates to their standard lower counterpart (60→30, 59.94→29.97, 50→25, 48→24)
- Quality tiers via `--quality`: `very-high`, `high`, `medium` (default), `low`
- Default preset is `medium`; use `--slower` for preset `slow` (better compression, longer encode)
- Output file is auto-named as `.h265.`

#### Player and Playlists

Clicking media auto-creates a playlist from current directory files. Player bar shows current item with controls. Click to expand for seek controls, time display, and queue dialog.

Queue dialog highlights active item; click any item to jump. Shuffle button plays all media recursively in random order (skips non-media).

- Images: auto-advance every 5s
- Videos/audio: play/pause, prev/next, seek
- Fullscreen: videos and images only

**History Tracking**
- Click the Raikiri logo to open a history modal with last 50 videos (not audio/images) played
- History is stored in browser localStorage and shows full file path as most recent first

**Video Playback**
- Compatible MP4s (H.264/HEVC + AAC 48kHz stereo) are served directly via HTTP range requests for instant playback
- All other videos are HLS-segmented to 6s fMP4 segments via `ffmpeg`, with audio transcoded to 48kHz AAC to prevent A/V drift
- Audio is played back directly in HTML5
- Unplayable files open in new tab as raw GET

**Subtitles**
- Auto-detection of SRTs in same directory, `subs/`, or `Subs/`
- Auto-extraction of embedded subtitle tracks
- All subtitles are converted to WebVTT and served as options
- CC button allows selecting across available tracks or disabled

#### Quickie on Playback Sync

- Compatible videos are served directly; others are HLS transmuxed/transcoded via `ffmpeg` (full seekability, format compatibility)
- Fullscreen player with custom overlay with controls (play/pause, +-10s seek, seek bar, exit)
- Fullscreen disabled for audio (images/videos only)