1 of 7

5.support

REST API

Learn how to control the client using REST

Cider offers a simple REST API to remotely control the app.

URL: http://localhost:9000/api/

Endpoints

Disclaimer

The disclaimer for what support we can provide through GitHub or Discord. Please note this before proceeding to ask for help.

Support (Releases)

Support is fully provided to all releases made on GitHub. Please open an issue, and we will try and fix the issue ASAP. Upon issues being fixed, you will need to wait until the next release if you wish to experience the fixed version in a stable state.

Support (Compiling)

If you experience issues in the compiling process, support is not provided. All commits made will generate a release, these can be found here. We advise you to revisit the compiling guide if you experience issues.

Support (Nightly/Beta Releases)

In Nightly/Beta releases the same applies as with normal releases: Support is fully provided and feel free to open an Issue on GitHub if you have problems. However, with these types of releases, you need to remember that they are non-stable releases and you may encounter issues. These builds of the application do not reflect the complete state of the app in any way.

Support (Third Party)

No support is provided outside the releases made on GitHub and on the Microsoft Store. Issues for external packages (AUR, Flatpak, Snap, etc.) should be opened with the relative repository/platform, or by contacting the author.

Troubleshooting FAQ

The main Frequently Asked Questions for Cider application support.

This is essential knowledge for the debugging process, please read these before creating an issue.

How to find the Application Data Directory

The location of your application data varies depending on your operating system, see your platforms path below:

Winget / GitHub Release (.exe)

Application data can be found at %appdata%\Cider

(C:\Users\<username>\AppData\Roaming\Cider)

Windows Store (appx)

Application data can be found at C:\Program Files\Windows Apps\**Cider**

The asterisks imply wildcard as the package name varies with an ID and the author.

Application data can be found at $HOME/.config/Cider

Application data can be found at $HOME/Library/Application Support/Cider

Why is my DiscordRPC status not appearing?

Try the following if Discord Rich Presence is not appearing on Discord.

Discord Desktop Client Only

Ensure you only have the Discord desktop client, not the web client open. As Cider is not directly connected to Discord we cannot have your status showing when not connected to Cider directly through Discord's Rich Presence functionality.

Activity Status Message

Make sure that 'Display current activity as a status message' is enabled in your Activity Status category in the Discord settings. Cider will not appear as a game, so do not manually add it.

Snapcraft Store Issues

If you are using Discord from the Snap Store, you are advised to install from a different source (Discords Website or using another package manager). The Snap Store version of Discord is known to have issues with DiscordRPC.

Permissions and Elevation

Ensure that you are running Discord on a level that is below Cider. If Discord is being elevated, Cider will be unable to connect. Furthermore, ensure that Discord is started first. Cider has to connect to Discord and this is only done on Cider's launch. So make sure Discord is started before Cider.

Cannot Cast on my Network (Windows)

For issues when attempting to cast your music, do the following:

Open Control Panel
Click Network and Internet
Click Network and Sharing centre
Click Change Advanced Sharing Settings on the left-hand side
Expand the Guest or Public list and turn on both options.
Restart your PC

Cider is Skipping or Not Playing Explicit Songs

If you are experiencing this issue, your account might have content restrictions set to "Clean". To check go to your Apple Media Account Settings and check the "Content Restrictions" section.

Make sure that Music is set to Explicit.

Technical FAQs

The main FAQs for those who wish to learn more about Cider's code base or wish to integrate it with their system.

Cider Media Player Information (MPRIS - Linux)

Running Cider for Development

While we encourage the use of the dist command in the compiling documentation, the main command that is useful for testing most functionality of the app is with the following commands:

start
- This launches the app using normal electron and building the JS from Typescript.
start-renderer
- This launches the app using normal electron but does not build new build files. (Build would need to be run previously, but if no changes have been made to the backend this command would work fine.)

Both these commands allow the app to launch with the notable limitation on macOS and Windows of no playback. Linux playback works in an uncompiled state.

Troubleshooting

Some useful steps to resolving your issues.

Troubleshooting can be done in a series of ways. Below is a list of the current methods you can troubleshoot issues with the application.

1: Clean Installation

A clean installation can be done by doing the following guide associated with your operating system:

Note: This will remove your current login state and unsynced data (Settings, Followed Artists).

Windows

Uninstall the Cider application using the control panel.
Delete the following folders:
- %appdata%/Cider (If its present)
- %LOCALAPPDATA%\Programs\cider (If its present)
- %LOCALAPPDATA%\cider-updater (If its present)
Reinstall Cider.

Linux

Uninstall the Cider application using your system uninstaller.
Delete the .config/Cider folder. (If its present)
Reinstall Cider.

macOS

Delete the Cider.app file from your Applications folder.
Delete the Library/Application Support/Cider folder. (If its present)
Reinstall Cider

Version Information

This page outlines each version of Cider and its current state.