Skip to content
Documentation Portal →

Setup

Not a product

This documents an internal test environment. See the overview for what POC Sandbox is and is not.

Getting the sandbox working means pointing a portal instance at it and proving a issue arrives.

Before you start

You need:

  • Access to the bydynamics GitHub organisation
  • The portal GitHub App installed on AL-SupportPortal-POC-Sandbox
  • The POC shared key for the environment you are testing

1. Confirm the app is installed

The portal writes issues as a GitHub App, not as a person. If the App is not installed on the sandbox repo, every write fails — and it fails as a 404, not a permission error, so it looks like the repo does not exist.

gh api repos/bydynamics/AL-SupportPortal-POC-Sandbox/installation --jq '.app_slug'

2. Point the portal at it

Set the environment to POC mode. Every issue then routes to the sandbox regardless of the app chosen on the form.

POC_MODE=true

This setting is refused in production

A production instance that starts with POC_MODE=true will not start at all. The check exists because POC mode replaces per-person sign-in with a single shared key, and a shared key in front of real customer issues means no issue has a provable author.

If you see the platform refuse to boot with a message about POC mode, that is the guard working. Do not remove it — change the environment instead.

3. File an issue and watch it arrive

Open the portal, choose any app, and file an issue. Then confirm it landed:

gh issue list --repo bydynamics/AL-SupportPortal-POC-Sandbox --limit 5

The issue should carry three labels: customer:<your-org-slug>, app:<whatever you chose>, and source:portal.

If the labels are missing, stop

An issue without its customer: label is invisible to the person who filed it — the portal only shows issues carrying a label the caller may read. It is not lost, but nobody will find it through the portal.

4. Clean up

Sandbox issues accumulate. Close them when you are done; there is no retention policy and no one triages them.