Connect hello-world repository missing?

Confluence Development Confluence Cloud
6

Sorry about missing documentation around ngrok; as it is a third party solution being evolved, we missed updating our documentation. We are on it! (I am under @SeanBourke’s team)

Unfortunately, Connect app installation service blocks the app server localhost access, which means app developer needs some tunnelling solution so that your descriptor file can be accessed through https protocol. You can use other option other than ngrok if you want to, such as Cloudflare tunnel, Localtunnel etc.

Once you find any tunnel solution to expose your app server access from public, you can override the AC_LOCAL_BASE_URL environment variable when developing. This sets the baseUrl and developers can then install the app via development mode.

For example,

  1. start tunnelling
  2. run AC_LOCAL_BASE_URL="https://uwekoch.example.com" npm start in a separate terminal

OR if you do not want to auto-register (auto-install)

  1. delete credentials.json file
  2. start tunnelling
  3. run AC_LOCAL_BASE_URL="https://uwekoch.example.com" npm start in a separate terminal
  4. go to UPM (https://your_jira.atlassian.net/plugins/servlet/upm) and upload your descriptor
    image
    image2800×1309 314 KB

Hope this helps!

James

2 Likes