Private App Development and Installation
    • Dark
      Light
    • PDF

    Private App Development and Installation

    • Dark
      Light
    • PDF

    Article summary

    Rocket.Chat allows you to develop and upload private apps tailored to specific workspaces. These apps are functional only within the workspaces where they are manually installed. You can also share your app package privately with other workspace owners for use in their respective environments. To begin developing a Rocket.Chat app, refer to the Apps-Engine guide.

    Starting with Rocket.Chat Version 7.0, the ability to upload private apps is now restricted to our premium plans (Starter, Pro, and Enterprise). This change is designed to maintain the integrity of Rocket.Chat's customization options while safeguarding the exclusive features of our paid plans. By limiting private app uploads, we ensure that only licensed users can fully tailor their experience, protecting both the value and security of our platform.

    Upload a private app

    To install a private app in Rocket.Chat, ensure that your app is packaged in a .zip format. Follow these steps to complete the installation on your workspace:

    1. Navigate to the Private Apps section
      Go to Administration > Marketplace > Private Apps.

    2. Upload the Private App
      Click on Upload Private App.

    3. Select Installation Method
      Choose either the installation via URL or a .zip file. Note that the option to upload apps from URLs is deprecated and will be removed in the next major release.

    4. Complete Installation
      Agree to the required permissions to finalize the installation. Once complete, your app will be installed and ready to use.

    For Rocket.Chat workspaces on versions less than 6.0, go to Administration > Settings > General > Apps and Enable development mode, then proceed to Administration > Apps to Upload App.

    In Rocket.Chat versions lower than 6.0, you can continue using all previously enabled public and private apps. However, purchasing or enabling new apps is restricted once the app limit is reached.

    Enable or disable a private app

    After uploading a private app to your workspace, it is enabled by default, and you can start using it. If you don’t want to use the app but still need it, you can disable it for any period of time. You can enable and disable an app in the following ways:

    • Go to the Private Apps section of the Marketplace in your workspace. Select the kebab menu against an app and click Enable or Disable.

    • Go to the App Info page of the app you want to enable or disable. Select the kebab menu under the app name and description. Click Enable or Disable according to your needs.

    App installation and usage limits by plans

    Premium plans

    Public apps

    Private apps

    Install

    Unlimited

    Unlimited

    Enable/Use

    Unlimited

    Unlimited

    Community workspaces

    Public apps

    Private apps

    Install

    Unlimited

    Unlimited (from 7.0, the installed apps will be disabled by default)

    Enable/Use

    5

    3 (! to be updated to 0 from 7.0)

    Currently, Community users can install unlimited apps after reaching the enabled app limit. To enable the new apps, users must disable existing enabled apps or upgrade to a premium plan.

    Workspaces with an expired premium license will have all their apps disabled if they exceed the community workspace’s limit. The app count will return to zero.

    Private app limit for Community workspaces from 7.0

    Starting with Rocket.Chat version 7.0, only workspaces on premium plans can install and use private apps. For community users, the following changes will apply:

    • Exemption to existing private apps:
      If you had private apps installed and enabled before upgrading to version 7.0, you will still be able to use them. Rocket.Chat will exempt these apps from the private app limit policy.

    • Re-enabling disabled apps:
      If you disabled an app before updating to version 7.0, you can re-enable and use it after the update.

    • Uninstalling private apps:
      If you uninstall a private app after upgrading to version 7.0, you will not be able to re-upload or reinstall it.

    • Downgrading from Premium to Community after a trial period or paid subscription:
      You will be able to continue using the apps you have after downgrading your workspace.


    Was this article helpful?

    ESC

    Eddy AI, facilitating knowledge discovery through conversational intelligence