A multi-user music service for self-hosting.

• No collection of privacy
• Multiple users
• Shared musicbill between users
• Support of importing music and music directory
• PWA supports both desktop and mobile
• Separation of playlist and custom playqueue
• Search of music, singer, musicbill and lyric
• System media shortcut
• Support of building APP from HTTP API
• Support of Two-Factor Authentication

You can deploy cicada by under options, and initial user of cicada is username:cicada/password:cicada.

Download from releases and start server:

If your platform isn't x64, you can build by yourself

./cicada start

Now cicada is available on localhost:8000 or {{ip}}:8000. You can get more options by running cicada start -h or cicada -h.

docker run \
  -d \
  --restart=always \
  -p 80:8000 \
  -v <data>:/data \
  --name cicada \
  mebtte/cicada:v2 \
  start --port 8000 --data /data

You can use --user {uid}:{gid} to map user.

services:
  cicada:
    restart: always
    container_name: cicada
    image: mebtte/cicada:v2

    # user mapping
    # user: 1000:1000

    command: start --port 8000 --data /data
    ports:
      - 80:8000
    volumes:
      - /path/data:/data

When using source code to deploy, you should install Node>=18 first.

git clone https://github.com/mebtte/cicada.git
cd cicada
npm ci
npm run build:pwa
npm start -- -- start --port <port> --data <data> # attention: double --

When needing to upgrade, you should run below commands:

git pull # pull the latest code
npm run build:pwa # rebuild pwa
npm start -- -- start --port <port> --data <data> # restart the server

If you migrate to v2 from v1, you must upgrade data before serving:

cicada upgrade-data <data>

docker run -it --rm -v <data>:/data mebtte/cicada:v2 upgrade-data /data

git fetch -p
git switch v2
npm ci
npm start -- -- upgrade-data <data>

• From v0 to v1

You can use cicada import to import music file and music directory, but the filename must to fit the below format:

singer1[,singer2][,singer3] - name.format

For example, Jarryd James,BROODS - 1000x.flac / 周杰伦 - 晴天.mp3 is valid and Numb.m4a / Daniel Powter Free Loop.mp3 is invalid, the file has invalid filename will be passed when importing.

# import direcoty
cicada import --data /path_to/cicada_data --recursive <music_directory>

# import file
cicada import --data /path_to/cicada_data <music>

# import directory
docker run -it --rm -v <data>:/data mebtte/cicada:v2 -v <music_directory>:/source import --data /path_to/cicada_data --recursive /source

# import file
docker run -it --rm -v <data>:/data mebtte/cicada:v2 -v <music_directory>:/source import --data /path_to/cicada_data --recursive /source/<music>

# import directory
npm start -- -- import --data /path_to/cicada_data --recursive <music_directory>

# import file
npm start -- -- import --data /path_to/cicada_data <music>

According to known issues, some old versions of cicada will breakdown the data, you can fix it by using below command:

cicada fix-data <data>

This command is unharmful, so you can run it even the data isn't broken. Also can run the command by docker or source code:

docker run -it --rm -v <data>:/data mebtte/cicada:v2 fix-data /data

npm start -- -- fix-data <data>

Cicada is a monorepo that contains two sub-projects under the apps directory. cli is for the server, which is used to manage assets and start services. pwa is for the client, which is used to access for users. And there is a shared directory on the root, which contains the code runs on both cli and pwa.

If you want to develop or contribute, most of cicada is developed by TS/JS and you should know it. Cicada relies on Node>=18 and you should install it on your device first.

Clone the project:

git clone https://github.com/mebtte/cicada.git

Install the dependencies:

npm install

Use commands of cicada CLI:

npm start -- -- <command> <options> <argument>

Before developing PWA, you should start dev server first:

CICADA_DATA=<data> npm run dev:server
# CICADA_DATA is the directory of data

Modify the code of cli and the cicada server will restart automatically. Then open another terminal window and start the pwa server:

npm run dev:pwa

Visit localhost:8001 and use http://localhost:8000 as server address, modify the code of pwa and you will see the change after auto reload.

There are useful documentations:

• Cicada API

UPDATE user SET password = <md5<md5<password>>> WHERE username = <username>;
UPDATE user SET twoFASecret = NULL WHERE username = <username>;

GPL