Aonsoku

A modern desktop client for Navidrome/Subsonic servers built with React and Rust.

Web App · Report Bug · Request Feature

Table of Contents

1. Features
2. Screenshots
3. Getting Started
   • Prerequisites
   • Installation
   • Running
   • Recommended IDE Setup
4. Roadmap
5. Contributing
6. Translation
7. License

Features

• Subsonic Integration: Aonsoku integrates with your Navidrome or Subsonic server, providing you with easy access to your music collection.
• Intuitive UI: Modern, clean and user-friendly interface designed to enhance your music listening experience.
• Unsynchronized lyrics: If your songs have embedded unsynchronized lyrics, Aonsoku is able to show them on full screen mode.
• Radio: If your server supports it, listen to radio shows directly within Aonsoku.
• Scrobble: Sync played songs with your server.

(back to top)

Screenshots

(back to top)

Getting Started

Prerequisites

• Node.js
• pnpm, npm or yarn
• Rust
• cargo

Installation

1. Clone the repo

git clone https://github.com/victoralvesf/aonsoku.git

2. Install NPM packages

pnpm install

3. Install tauri-cli

cargo install tauri-cli

Running

• Web App

pnpm run dev

• Desktop App

pnpm run tauri dev

• Docker

version: '3.8'

services:
  aonsoku:
    container_name: aonsoku
    image: ghcr.io/victoralvesf/aonsoku:latest
    restart: unless-stopped
    ports:
      - 8080:8080

Environment Variables

Below is a table describing the environment variables that can be used in this project. Adjust them as necessary in your .env file.

Variable	Default	Description	Required for Automatic Login
PORT	8080	The port the application runs on.	No
SERVER_URL		If you want the app to access a predefined Subsonic server. Format: http://your-subsonic-server:port.	Yes
HIDE_SERVER	false	Set to true to hide the server URL field on login and only show username and password.	Yes
APP_USER		The username for automatic login.	Yes
APP_PASSWORD		The password for automatic login.	Yes
APP_AUTH_TYPE	token	Specifies the authentication method. Options: token or password.	No

Notes:

• Automatic Login: To enable automatic login across devices. This should only be used in secure local environments to avoid password compromise.
• Legacy Authentication: Use APP_AUTH_TYPE=password only if your server does not support token-based authentication.

Recommended IDE Setup

• VS Code + Tauri + rust-analyzer

(back to top)

Roadmap

• Downloads:
  • Playlist
  • Album
  • Artist
  • Song
• Queue page
• Playlist editor
• Synced lyrics
• Podcast support

Feel free to request more cool features here.

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Translation

This project uses Weblate for translations. If you'd like to help, please visit the link to submit your contribution.

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)