Skip to content

Releases: Super-Badmen-Viper/NineSong

NineSong-v1.0.4

15 Jun 15:09

Choose a tag to compare

NineSong Music Service Deployment Guide

📋 Pre-deployment Preparation

Place the .env and docker-compose.yaml files in the same folder. You can customize the parameter configuration of .env and docker-compose.yaml, such as mapping the media library folder to the Volumes of the NineSong container.

⚙️ Environment Configuration

MongoDB Version Configuration (@.env 43-52)

MONGO_VERSION=6.0  # Default MongoDB 6.0 (recommended for better performance)

⚠️ Important Notice: If your CPU doesn't support AVX instruction set (such as older Intel processors), MongoDB 6.0 won't start. Solution: Set MONGO_VERSION to 4.4.

🔍 Check Method: Run docker info | grep -i cpu in terminal to check CPU features

🚀 Deployment Options

Two deployment options are available, please choose one according to your needs:


📁 Deployment Option A [Mount Single Media Library Folder Path]

  1. Modify the .env file content
  2. Set the MEDIA_DATA_HOST_PATH parameter value to the folder path that needs to be mounted

📁📁 Deployment Option B [Mount Multiple Media Library Folder Paths]

  1. Modify the docker-compose.yaml file content
  2. Append the folder path to be mounted under the volumes parameter in the backend container
  3. Please search online for instructions on how to make the changes

▶️ Start Service

Finally, execute the command in the file directory:

docker compose up -d

🔧 Permission Issue Handling

If permission-related errors occur during execution, please try the following solutions:

Linux/macOS Systems:

# Execute with sudo (recommended)
sudo docker compose up -d

# Or add current user to docker group
sudo usermod -aG docker $USER
# Then re-login or execute
newgrp docker

Windows Systems:

  • Run PowerShell or Command Prompt as administrator
  • Or ensure Docker Desktop runs with administrator privileges

Execution completed, open the webpage corresponding to the port number.

🔐 Initial Login Information

🗑️ Complete Reinstallation of NineSong

Note: Need to clear data together with Volumes in Docker.

Considering that image upgrades should not affect database data, if you delete NineSong containers, the data in their databases will not disappear unless you clear it together with the data in Volumes in Docker.

Clear Command Examples:

# Stop and remove containers
docker compose down

# Remove related volumes
docker volume rm ninesong-docker-compose_dbdata
docker volume rm ninesong-docker-compose_metavolume

# Redeploy
docker compose up -d

🔧 Troubleshooting

MongoDB Startup Failure

If you encounter MongoDB startup issues, please check:

  1. Whether CPU supports AVX instruction set
  2. If not supported, change MONGO_VERSION in .env to 4.4

Permission Related Issues

  • Ensure Docker has sufficient permissions to access the specified media folders
  • Check if folder paths exist and are readable/writable
  • Linux systems may need to adjust SELinux or AppArmor settings
  • If containers cannot access system resources, check if administrator permissions are correctly set
  • Windows systems ensure Docker Desktop runs with administrator privileges

Port Conflicts

  • Check if port configurations in .env file are occupied
  • Can modify APP_PORT and SERVER_PORT parameters to use other ports