Link

Configuration

Table of Contents

  1. nextauth-mgmt
  2. nextauth-portmap

Two Docker images are provided as a utility to run the NAS:

  • nextauth-mgmt contains the management interface for the NAS, providing both the Dashboard and Account Management;
  • nextauth-portmap is a tool for testing environments, which you can use to expose the NAS ports, Dashboard and Account Management web interfaces.

nextauth-mgmt

The nextauth-mgmt Docker image is entirely configured through environment variables. It expects the NAS API to be available at nextauth:8888. This is set up by default if you use the nextAuth provided docker-compose.yml.

It requires only one environment variable in order to access the NAS:

  • NEXTAUTH_ROOT_APIKEY: Root API key for the nextAuth API.

nextauth-portmap

The nextauth-portmap Docker image is also entirely configured through environment variables.

The portmap utility will act as a HTTP proxy, mapping URLs to a specific host and port. Portmap supports TLS and will automatically request TLS certificates from LetsEncrypt when configuring a https:// URL.

For production environments nextauth-portmap should not be used, but a proper reverse proxy with TLS termination should be set up.

  • NEXTAUTH_WS_URL: WebSocket endpoint, using HTTPS is strongly recommended (e.g., https://ws.mysite.com/).
  • NEXTAUTH_WS_MAP: Host and port to forward websocket requests to (e.g., nextauth:8009).
  • NEXTAUTH_PROTO_URL: nextAuth protocol endpoint (e.g., http://n.mysite.com/n/).
  • NEXTAUTH_PROTO_MAP: Host and port to forward nextAuth protocol requests to (e.g., nextauth:8889).
  • NEXTAUTH_DASHBOARD_URL: Dashboard web interface endpoint, using HTTPS is strongly recommended (e.g., https://dashboard.mysite.com/). Using a subfolder URL (e.g., https://www.mysite.com/dashboard/) is not supported.
  • NEXTAUTH_DASHBOARD_MAP: Host and port to forward dashboard requests to (e.g. nextauth-mgmt:80)
  • NEXTAUTH_ACCOUNT_URL: Account Management web interface endpoint, using HTTPS and wilcard subdomains is strongly recommended (e.g., https://account.mysite.com/ https://*.account.mysite.com/)
  • NEXTAUTH_ACCOUNT_MAP: Host and port to forward account management requests to (e.g., nextauth-mgmt:81)
  • NEXTAUTH_IDP_URL: Identity Provider endpoint, using HTTPS and wilcard subdomains is strongly recommended (e.g., https://idp.mysite.com/ https://*.idp.mysite.com/
  • NEXTAUTH_IDP_MAP: Host and port to forward IdP requests to (e.g., nextauth-mgmt:82)
  • NEXTAUTH_TLS_EMAIL: Email address to use for TLS certificate requests towards LetsEncrypt (e.g., certificates@mysite.com)
  • ACME_AGREE: Set to “true” to accept the LetsEncrypt terms and conditions.