readme.md

Cicada

A multi-user music service for self-hosting.

Feature

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

Deployment

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

Binary

Download from releases and start server:

If your platform isn't x64, you can build by yourself or deploy by source code.

./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

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.

Docker Compose

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

Migration

From v1 to v2

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

Binary

cicada upgrade-data <data>

Docker:

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

Other versions

• From v0 to v1

Music import

You can use cicada import to import music file or music directory. If Cicada can get music tags from the file, it will be imported. If not, it will be ignored.

Binary

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

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

Docker

# 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>

Data fixing

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:

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

Development

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> <arguments>

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

Contributor

Q & A

How to migrate data?

All of data is under {{data}} directory, copy or move it to new device.

How to login if I forget the password ?

1. If you are a normal user, you should contact the admin and let him/her help you to change the password. Above operation will also disable 2FA for your account.
2. If you are an admin, you can let other admins help you to change the password or update the sqlite database using below SQL:

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

License

GPL

Star History