github.com/any-listen/any-listen @webserver-v0.9.1 sqlite

A cross-platform private music playback service

English | 简体中文 | 繁體中文

This project is under active development and currently provides both a Desktop version and a Web service version.

Features

• Add and play local songs (standard playlists and local lists)
• Add and play songs stored on WebDAV (remote lists)
• Online song metadata matching (cover, lyrics; install the relevant extension via Extension Manager)
• Add and play online resources (playlists, charts; install the relevant extension via Extension Manager)
• Experimental audio effects
• Karaoke lyrics and title bar lyrics

Desktop Version

Grab the latest release and install it from: https://github.com/any-listen/any-listen-desktop/releases

Web Version

You can deploy it directly to your server, or use Docker for deployment.

Docker Deployment

Image release: https://hub.docker.com/r/lyswhut/any-listen-web-server

Direct Deployment

Requirement: Node.js 20+

Download the latest version and extract it to your target directory: https://github.com/any-listen/any-listen-web-server/releases

Refer to https://github.com/lyswhut/lx-music-sync-server for deployment methods. See below for configuration file instructions.

Upgrade steps:

1. Delete the public and server folders in the old project directory
2. Upload the new version's public and server folders to the project directory
3. Restart the service

Usage Example:

1. Create the configuration file data/config.cjs

   ``js const config = { // port: '9500', // Bind port // bindIp: '127.0.0.1', // Bind IP // httpLog: true, // Enable HTTP request logging // 'cors.enabled': false, // Enable CORS // 'cors.whitelist': [ // Allowed CORS domains, empty array allows all // // 'www.xxx.com', // ], // 'upstreamProxy.enabled': false, // Use proxy for requests // 'upstreamProxy.header': '', // Proxy request header (e.g.x-real-ip) // 'extension.ghMirrorHosts': [], // Extension store Github mirror addresses // httpProxy: '', // Proxy server address, e.g.127.0.0.1:2080`

   // Allowed local directories // allowPublicDir: ['G:', 'E:\music'], // Windows example // allowPublicDir: ['/music'], // Linux example password: '123456a', // Login password }

   module.exports = config ```

2. Run the Docker container

   Note: The following command is for example only and cannot be used directly!

   bash docker run --volume=/home/music:/music --volume=/data:/server/data -p 8080:9500 -d test:latest

Environment Variables

Build from Source

pnpm install
pnpm run build:web
cd build
mkdir data
# Create config file config.cjs
node index.cjs

Contributing

PRs are welcome! To ensure your PR can be merged smoothly, please note the following:

• For PRs adding new features, it is recommended to create an Issue first to confirm the necessity of the feature.
• For PRs fixing bugs, please provide explanations and reproduction steps before and after the fix.
• For other types of PRs, please include appropriate explanations.

Steps to contribute:

1. Clone the repository and switch to the dev branch for development;
2. Submit your PR to the dev branch.

License

This project is licensed under the Affero General Public License (AGPL) v3.0 with the following additional terms:

• Commercial use is strictly prohibited unless written permission is obtained from the original author.
• For full details, please refer to the LICENSE file.