Rate this page:
When you’re ready to share your Forge app with users, you’ll need to enable sharing for your app in the developer console. This generates a link that you can share with users to install your app on their Atlassian site. Note, in order to install it, they must be the admin of a product on that site. They will also be able to use this link to uninstall your app, and update your app when you release new versions.
Use this method to share your apps for internal use, or to test your apps before listing them on the Atlassian Marketplace. Note, apps that already have a license in the app manifest or have been submitted for listing on Marketplace can't be shared via installation link; in order to share and test these apps, you'll need to copy the app's code, create a new, unlicensed version of the app, and share this version via installation link.
You can stop sharing your app at any time.
Using the Forge CLI, deploy your app to the production environment.
In the developer console, choose the app you want to share.
Select Distribution in the left menu, and under 'Distribution controls', select Edit.
Select the Sharing option, fill in the app details, and select Save changes.
Select which Atlassian products you want your user to install your app on.
Copy the installation link, and send it to your user. Remind them to keep the link somewhere safe, as they'll need it to update or uninstall the app in the future.
When your user visits the link, an installation screen appears, similar to the one below. It displays information about your app, including the permissions your app is requesting. From here, your user can choose a site and product to install your app on.
If you want to stop sharing your app with users, you must disable sharing in the developer console.
Your app is no longer being shared. This has the following effects:
You can start sharing your app again any time.
You might want to deploy a new version of your app that includes updated scopes. Once you've deployed the new version to the production environment using the Forge CLI, users can do one of the following:
Update the app through the Universal Plugin Manager (UPM).
Select the installation link you previously sent to them, and under the 'Installations' tab of the installation screen, select Update.
If needed, you can copy the installation link from the developer console and send it to them again.
If you've finished testing your app, and want to provide or sell it to a large customer base, see Listing Forge apps on the Atlassian Marketplace.
Note, once your app has been submitted for listing on Marketplace, or has a license in the app manifest, it can't be shared via installation link. In order to share and test this app, you'll need to copy the app's code, create a new, unlicensed version of the app, and share this version via installation link.
Rate this page: