YouTrack Server 2024.3 Help

Manage Apps

The Apps page lets you manage the status of all your installed apps in a central location. Here, you see all the apps that have been installed on your YouTrack site and access to settings for the individual apps.

To access this page, open the Administration menu and select Apps.

Custom app list

The following actions are available in the header of the Apps page:

Action

Description

Add app...

Opens a drop-down menu where you can select:

Download

Downloads a ZIP file of the app to your local directory.

Filters

The following filters are available to display apps in the list.

  • Toggle between displaying All apps or only apps originating From Marketplace.

  • Select an app Category to display one or more categories of apps in the app list.

  • Enter a search string in the Filter by name box to filter by app name.

Multiple filters can be used at the same time.

App List

The app list displays all apps installed on your YouTrack site.

The following attributes are displayed for each app in the list:

Attribute

Description

Icon

The image that is shown for the app.

Name

The name of the app.

Category

The app category is located under the app name.

Status

Displays if the installed app is available for use on your YouTrack site.

  • Active — The app is active and available for use in YouTrack.

  • Inactive — The app has been installed but is not available for use in YouTrack.

Last Update

The date of the most recent update to the app.

Show more

Click the Show more icon for additional options.

  • Contact vendor opens a dialog to select an email client to start communication with the email listed for the app.

  • Add to projects... opens a dialog to enable or disable the app in specific YouTrack projects.

  • Delete opens a dialog to confirm the complete deletion of the app from YouTrack.

App Details Sidebar

The app details sidebar contains information and tools for each app installed on your YouTrack site.

Attribute

Description

Active toggle

Use this toggle to activate or deactivate the app.

App name

The name of the app and the app author listed below.

Description

A description of the app.

Settings

App settings including visibility restrictions.

Projects

A list of projects where the app can be used.

  • Click the Manage projects button to add or remove projects for use with the app.

  • Enable the Auto-attach toggle to attach the app to new projects by default.

Technical Details

Displays the app version number. Additional technical information about the app depends on the app type.

  • Workflow apps have options to open the workflow in an editor, view the JSON manifest, download logs, and view the workflow rules.

  • Apps containing more than one module list the different modules within the app.

Add Apps to YouTrack

Apps can be added to YouTrack by being installed directly from the JetBrains Marketplace or by uploading your own custom app.

Install an App from JetBrains Marketplace

YouTrack administrators can install new apps directly to a YouTrack site with internet access to the JetBrains Marketplace.

To install an app from the marketplace:

  1. From the Administration menu, select Apps.

  2. Click the Add app... button.

    • Select Browse JetBrains Marketplace.

    Install apps from JetBrains Marketplace.

    Your web browser opens a page on JetBrains Marketplace.

  3. Browse the JetBrains Marketplace for YouTrack apps.

    • Click the app you want to add to your YouTrack site.

  4. Enter your YouTrack base URL and then click the Install button.

    Install apps from JetBrains Marketplace.
  5. Your YouTrack site is opened in a new browser window.

    • A dialog box opens with a description of the app.

    • Click the Install button to begin installing the app on your YouTrack site.

If the app was successfully installed, a successful conformation notice is displayed, and the details sidebar of the newly installed app opens.

If the app was unsuccessfully installed, an error message is displayed.

Upload an App

If you want to use a custom app that has not been installed, it can be uploaded manually to YouTrack.

To upload a new app:

  1. From the Administration menu, select Apps.

  2. Click the Add app... button.

  3. Select Upload ZIP file... to install an app from a local file.

    • Select a ZIP file containing a YouTrack app.

    New app

    The ZIP archive is checked to make sure that it conforms to the size limitations. For details, see Size Limitations

If the app was successfully installed, a successful conformation notice is displayed, and the details sidebar of the newly installed app opens.

If the app was unsuccessfully installed, an error message is displayed.

Update an App

The process for updating an app differs for apps that have been uploaded manually and apps installed from the marketplace.

Update Apps from JetBrains Marketplace

If the latest version of an app from the marketplace hasn't been applied yet, you can pull updates directly into YouTrack.

The update available badge in the list indicates that a newer version of the app is available. The New version available is shown in the details sidebar of an app.

To update an app from the marketplace:

  1. From the Administration menu, select Apps.

  2. Select the app that you want to update.

  3. In the details sidebar, click the Update button.

    • Updates are applied to the existing app.

    • Any additional functionality supported in the new version is immediately available.

Update Manual Uploads

Manually installed apps can be updated by reinstalling an app of the same name. The new app overwrites the previous version.

Activate or Deactivate an App

If you no longer want users to work with an app but don't want to delete it from YouTrack, you can deactivate the app indefinitely.

For example, there are problems or bugs with an existing app that the developer would like to fix. You can disable the app so users don't experience problems with the current behavior and enable the app when the problems have been fixed in an updated version.

When an app is inactive, users who have installed the app on their dashboards see a message that the app was not found in the system. The edit and refresh controls are not visible. Instead, users see the option to remove the app.

To deactivate an app:

  1. From the Administration menu, select Apps.

  2. Select the app that you want to deactivate in the list.

  3. Click the Active toggle switch.

    • When the toggle switch is gray, the app is inactive.

Deactivated apps can be reactivated using the same control.

To activate an app:

  1. From the Administration menu, select Apps.

  2. Select the app that you want to activate in the list.

  3. Click the Active toggle switch.

    • When the toggle switch is blue, the app is active.

Visibility Settings

You can set the visibility for apps under the Settings tab in the details sidebar. This gives you control of which groups, teams, and users have access to specific apps.

To set the visibility for an app:

  1. From the Administration menu, select Apps.

  2. Select the app to view or update visibility settings.

  3. Select the Settings tab in the details sidebar.

  4. Click to open the drop-down menu under Visibility.

    • Add or remove groups, teams, or users from the visibility list.

    Custom app list

The visibility of the app is updated immediately following a change in the settings.

Delete an App

If you have apps in YouTrack that are no longer supported, you can delete them. For example, when an app displays information from an application that your team no longer uses.

When you delete an app, users who have installed the app on their dashboards see a message that the app was not found in the system. The edit and refresh controls are not visible. Instead, users see the option to remove the app.

To delete an app:

  1. From the Administration menu, select Apps.

  2. Click the More options icon for the app you want to delete and select Delete.

    Delete custom app
  3. Confirm the action in the dialog by clicking the Delete button.

    • The selected app is deleted.

    • All settings and data from the app are removed from your YouTrack site.

Download an App

You can download apps as a ZIP file to a local drive. This makes it possible to edit apps and upload them to other YouTrack installations.

To download an app:

  1. From the Administration menu, select Apps.

  2. Select an app from the app list.

  3. Click the Download button.

    • The app is downloaded to your default download directory as a ZIP file.

    Download app
Last modified: 16 September 2024