Nuon BYOC: AWS

Documentation Index

Fetch the complete documentation index at: https://docs.nuon.co/llms.txt

Use this file to discover all available pages before exploring further.

​

Architecture

​

Requirements

​

AWS Account

• us-east-1
• eu-west-1

​

DNS

​

Root DNS

1. Before installation, create the DNS zone my-domain.com if it does not already exist.
2. Provide nuon.my-domain.com as the value for the Root Domain input.
3. Once Nuon BYOC has fully provisioned, the domains of the DNS servers for the install will be available in the outputs.
4. Create an NS record named nuon.my-domain.com, using the DNS server domains as the value.
5. Once propagation is complete, the Nuon Dashboard should be reachable at app.nuon.my-domain.com.

​

Delegation DNS

​

GitHub App

1. Go to GitHub App Settings and click New GitHub App
2. Configure the app with these settings:

3. Set permissions:

4. Under “Where can this GitHub App be installed?”, select Only on this account (unless you need to access repos in other GitHub organizations)
5. Click Create GitHub App
6. After creation, scroll to the bottom and click Generate a private key. Save this PEM file - you’ll need it later.
7. Note your App ID and Client ID from the app settings page.

​

Identity Provider

​

Google

1. Log into your Google Cloud Platform console.
2. Navigate to Google Auth Platform, and open the “Clients” tab.
3. Create a new client named “Nuon BYOC”.
4. Save the client ID and secret.
5. Add an authorized redirect URI with the value, https://auth.<your-root-domain>/auth.

​

Okta

1. In the Okta Admin Console, navigate to Applications and create a new OIDC application.
   1. For Sign-in method: Select OIDC - OpenID Connect
   2. For Application type: Select Web Application
2. Set the Sign In Redirect to https://auth.<your-root-domain>/auth
3. Set Trusted Origins to <your-root-domain>
4. Save the client id and secret.

​

Auth0 (DEPRECATED)

module "byoc_auth0" {
  source = "github.com/nuonco/byoc-auth0"
  # Your Auth0 tenant domain
  auth0_domain = "your-tenant.auth0.com"
  # The root domain for your BYOC install
  public_domain = "<your-root-domain>"
  # Your Nuon install ID
  install_id   = "<your-install-id>"
  install_name = "<your-install-name>"
}

1. Go to Actions > Library in your Auth0 dashboard
2. Click Create Action > Build from scratch
3. Name it AddScope and select the latest runtime
4. Replace the code with:

exports.onExecutePostLogin = async (event, api) => {
  const email = event.user.email;
  api.accessToken.setCustomClaim(`email`, email);
};

5. Deploy the action
6. Go to Actions > Triggers > Post Login
7. Drag the AddScope action into the flow and save

​

Slack App (Optional)

1. Copy the manifest below into a scratch buffer and replace both occurrences of <your-root-domain> with your actual root domain (e.g. nuon.my-domain.com). The host is the slack. subdomain in front of your install.
   display_information:
     name: Nuon
     description: Nuon BYOC deployment notifications in Slack.
     background_color: "#0b0b0f"
     long_description: |
       Nuon posts deployment lifecycle events from your installs, sandboxes,
       runners, and actions into the Slack channels you choose. Subscribe per
       org, filter by interest (failures, components, sandboxes, runners,
       actions).
   
   features:
     bot_user:
       display_name: Nuon
       always_online: true
     slash_commands:
       - command: /nuon
         url: https://slack.<your-root-domain>/slack/commands/nuon
         description: Manage Nuon notifications in Slack
         usage_hint: subscribe [install] | unsubscribe | status | help
         should_escape: false
   
   oauth_config:
     redirect_urls:
       - https://slack.<your-root-domain>/slack/oauth/callback
     scopes:
       bot:
         - chat:write
         - chat:write.public
         - channels:read
         - groups:read
         - team:read
         - commands
     pkce_enabled: false
   
   settings:
     org_deploy_enabled: false
     socket_mode_enabled: false
     token_rotation_enabled: false
     is_mcp_enabled: false
     interactivity:
       is_enabled: true
       request_url: https://slack.<your-root-domain>/slack/interactions
       message_menu_options_url: https://slack.<your-root-domain>/slack/interactions
     event_subscriptions:
       request_url: https://slack.<your-root-domain>/slack/events
       bot_events:
         - app_uninstalled
         - tokens_revoked
         - channel_rename
         - channel_archive
         - channel_left
   
2. Go to Slack API: Your Apps and click Create New App → From a manifest. Select your own Slack workspace as the development workspace — this is where you’ll manage the app’s settings going forward. Customers will install the app into their own workspaces later via OAuth. Paste the manifest and create the app.
3. Under Basic Information, copy your Client ID, Client Secret, and Signing Secret — you’ll provide these to Nuon as inputs and secrets.

​

Inputs

​

Authentication Configuration

​

GitHub Configuration

​

DNS Configuration

​

Database Configuration (Optional)

​

Slack Configuration (Optional)

​

Secrets

base64 -i your-github-app-key.pem

​

Provision

1. Return to your install in the Nuon dashboard
2. Click Reprovision Install from the Manage menu
3. Wait for the provision workflow to complete

​

Configure DNS (Optional)

• A Zone ID for your public domain
• Nameserver records to add to your domain’s DNS

​

Verify Installation

curl https://api.<your-root-domain>/health