In this guide you will install your locally running add-on into your Atlassian Cloud development environment; this is the development environment that you created during the Development setup guide.
In order to get an add-on that is running on your personal computer (locally) installed in an Atlassian Cloud instance, you need to make it available on the internet, served over an HTTPS connection.
To achieve this, there are many tools you could use, but we recommend ngrok. ngrok is a simple and free command line tool to tunnel your local development environment to the internet. To use ngrok:
- Download and install ngrok.
Find out what port your add-on is running on.
This can generally be done by running the add-on and looking for the port in the logs or by checking the project README for details. If you need a project, check out Connect Basics.
From the command line, run
ngrok http $PORTreplacing
$PORTwith the port used by your add-on.
- Get the HTTPS URL from the command line, as shown by the following image:
- Change the add-on's JSON descriptor so that the
baseUrlis set to the ngrok URL from the previous step.
Check that your descriptor now shows the correct
You can do this by navigating to the ngrok HTTPS URL with the path to your descriptor appended. Using the example above your descriptor URL might look something like:
https://02b76172.ngrok.io/atlassian-connect.json. When your descriptor loads, ensure that the
baseUrlis the publicly accessible ngrok URL.
Now that your add-on is accessible on the internet, over HTTPS, you can now install it into your development environment in the same way that you installed the example add-on in the Development setup guide.