Installing Serenade

Serenade

Installing the main Serenade client application

macOS

  1. Drag Serenade.app into your Applications folder.macOS Finder window with Serenade
  2. Open your Applications folder, and click Serenade to run it.
  3. Follow the prompts in the app to continue setup!

Windows

  1. Run the installer application, which will install and run the Serenade app.Windows Explorer window with Serenade
  2. Follow the prompts in the app to continue setup!

Linux

  1. Set the permissions of Serenade-*.AppImage to be executable with:
    chmod +x Serenade-*.AppImage
    Or, use a file manager UI to make Serenade executable.Ubuntu Linux Serenade file properties
  2. Run the Serenade-*.AppImage file, either via the terminal or a file manager UI.
  3. Follow the prompts in the app to continue setup!

Serenade Pro

Getting set up with Serenade Pro

Windows Only: Install WSL

Serenade Pro requires WSL to run on Windows. On macOS and Linux, no other dependencies are required.

If you already have WSL installed, then you're all set! If not, you can follow these steps to install.

  1. Open up PowerShell as an administrator and run:
    dism.exe /online /enable-feature /featurename:Microsoft-Windows-Subsystem-Linux /all /norestart
  2. Restart your computer.
  3. Install the Ubuntu app here. You can also search Ubuntu in the Microsoft Store.
  4. Open the newly installed Ubuntu app to complete the installation process.

Install Serenade Pro

Once Pro has been enabled on your account, Serenade Pro will download (and auto-update) when you start Serenade.

To switch to Pro, open Serenade, and then open the Settings window via the gear icon at top-right. Then, head to Server and select Serenade Pro.

Serenade Server Settings

JetBrains Plugin

Integrating Serenade with JetBrains IDEs

  1. Open the JetBrains preferences window.
  2. Navigate to Plugins on the left sidebar.
  3. Search for Serenade in the search bar, then click Install.JetBrains Plugins Window