Wiki > CherryMusic

CherryMusic is a Python music streaming server developed on Github.

Installation

1. Connect to your slot through SSH

2. Install pip for Python 3.8

    curl -s https://bootstrap.pypa.io/get-pip.py | python3 - --user
   

3. Install the cherrypy dependency

    pip3.8 install cherrypy
   

4. Download the latest release of CherryMusic

    git clone https://github.com/devsnd/cherrymusic.git
   

5. Start the configuration process. Port 15055 has been automatically generated for you, but you may use another 5 digit port between 10000 and 32767.

    screen -mS cherrymusic python3.8 ~/cherrymusic/cherrymusic --setup --port 15055
   

6. Open http://server.whatbox.ca:15055 in your web browser

7. Set the Media base directory option to /home/user/files or your chosen music directory. The rest can be left with default values.

8. Click the Save Configuration and start CherryMusic button at the bottom of the page. The WebUI will refresh.

9. You will be asked to enter an admin username and password. This account will have full control to create non-admin user accounts that can be used for friends/family.

10. In SSH, hit Ctrl-a followed by d to detach from the CherryMusic screen window while leaving it running.

Usage

• Click the menu in the top right corner to the options, including keyboard shortcuts. Admin users can also create new users and force an update of the music library.

• Stop CherryMusic by entering pkill cherrymusic in SSH

• Start CherryMusic again by entering screen -dmS cherrymusic ~/cherrymusic/cherrymusic in SSH

• Upgrade CherryMusic by stopping CherryMusic then entering cd ~/cherrymusic followed by git pull in SSH

• If you need to access your CherryMusic screen window, enter screen -r cherrymusic in SSH