Skip to main content

Prerequisites

Check everything below before you start the Installation.

Server​

ItemMinimumRecommended
CPU8 vCPU12+ vCPU
RAM16 GB32 GB
Storage150 GB SSD250+ GB SSD
Operating systemUbuntu 22.04 LTSUbuntu 24.04 LTS
  • A user with sudo rights, and SSH access to the server.
  • A fixed IP address. In domain mode, also a DNS name pointing at it.
  • Docker Engine 24+, Docker Compose v2, and Nginx are installed during the Installation - they do not need to be present beforehand.

Choose an Access Mode​

Decide how users will reach AuthNull, because it changes the .env settings and the Nginx configuration:

ModeUse whenYou also need
Domain with HTTPSThe server is reachable by a DNS nameControl of the customer's DNS, to create two A records (onprem.<domain> and default.<org>.<domain>), and port 80 open for certificate validation
Bare IP over HTTPThe server is reached by IP address only - for example on a private network over VPNNothing extra. Passkeys are not available in this mode; push MFA and authenticator app codes are

Inbound Ports​

PortFromNeeded for
22/tcpAdministratorsSSH
80/tcpUsersThe console (bare-IP mode), and HTTPS redirect and certificate validation (domain mode)
443/tcpUsersThe console (domain mode)

Products add their own ports later - for example 6133 (PostgreSQL) or 6033 (MySQL) for Database MFA. Each product guide lists them.

Outbound Access​

The server must be able to reach:

DestinationPortWhy
docker-repo-public.authnull.com443Pulling the AuthNull container images
download.docker.com, Ubuntu package mirrors443 / 80Installing Docker, Nginx, and other packages
github.com, raw.githubusercontent.com443Product agent installers (for example the database agent and ProxySQL)
smtp.elasticemail.com2525Sending verification, invitation, and enrolment emails
Your MFA provider443Delivering pushes: your Okta org or Duo API hostname; for the AuthNull Authenticator, Google Firebase Cloud Messaging
api.ipify.org443Used by ProxySQL on each database login (Database MFA only)
note

If image pulls are refused, log in to the registry with the credentials AuthNull provided: docker login docker-repo-public.authnull.com.

Accounts and Information​

  • An email address you can read - the organization's sign-up and verification emails go there.
  • The organization name (ORG_NAME). It becomes part of the tenant name, so choose it before you start.
  • An MFA provider:
    • AuthNull Authenticator - nothing to prepare; users install the app on their phones.
    • Duo Security - an admin account to create an application and obtain its API hostname, Integration key, and Secret key.
    • Okta Verify - an Okta admin account to create an API token. Users need Okta Verify enrolled, with the same email address as in AuthNull.
  • A phone for each user who will approve pushes, including you for testing.

Next Steps​

Continue to Installation.