AtmosphericX

Appearance

AtmosphericX LogoWritten By: KiyoWx
Last Updated: Feb 27th, 2026


Post Installation ​

Congratulations on installing AtmosphericX! This guide walks you through post installation steps to get your instance running smoothly, including dashboard access, admin setup, and optional cdn hosting a with Cloudflare Tunnel.

WARNING

Please make sure your server is running with start.sh (if you have already built the project) before continuing

Web Interface & Dashboard ​

AtmosphericX provides a web based dashboard for easy management. To access the web interface and dashboard, open your preferred web browser of choice and navigate to http://localhost (default port is 80). If you are running AtmosphericX on a different port, make sure to adjust the URL accordingly.

INFO

Default URL: http://localhost:80

During your first launch, you may be prompted to complete an initial setup wizard. Follow the on screen instructions to configure basic settings such as admin account creation.

Dashboard Status

The dashboard in this version is not yet fully completed. Some features may be unavailable.

Authentication & Setup Wizard ​

During the initial setup you will be prompted to create an administrator account with full access to AtmosphericX. When that prompt appears, enter the randomly generated authentication key that the setup page provides. The key is created automatically each time you open the setup page, remains valid only for the current setup session, and appears once in the console, so be sure to copy it before closing or refreshing the page. This step helps ensure secure access while your administrative account is being created.

Once you are authenticated, you can proceed to create your admin account by providing a username and password. Make sure to choose a strong password to enhance security. A full video walk through of the authentication setup process is provided below for your convenience.

Username Guidelines ​

Your username can contain letters, numbers, underscores, hyphens, periods, or exclamation marks, and must be 3–20 characters long.

Password Guidelines ​

Passwords can use letters, numbers, and many common special characters, and must be 4–50 characters long.

TL;DR ​

  1. Open the web interface
  2. Copy the authentication key from the console. (4 digits)
  3. Paste it into the setup page.
  4. Create an admin account with a username and a strong password.
Video WalkthroughVideo: Setup Wizard Guide

Cloudflare Tunnel Walkthrough ​

Cloudflare provides a free service to have the ability to host your instance of AtmosphericX on the internet without needing a public IP address or port forwarding. This is especially useful for users who are behind NAT or have dynamic IP addresses. To get started, you'll need a Cloudflare account. If you don't have one, visit cloudflare.com and sign up for free.

Step 1: Install Cloudflare Tunnel ​

Download and install cloudflared for your operating system:

  • Windows: Download the installer from Cloudflare's downloads page
  • Linux/Mac: Use your package manager or download directly from the official repository

Step 2: Authenticate with Cloudflare ​

Open your terminal and run:

​

sh
cloudflared tunnel login
sh
cloudflared tunnel create <TUNNEL_NAME>
yaml
# Create or edit `~/.cloudflared/config.yml` with the following configuration:
tunnel: <TUNNEL_NAME>
credentials-file: /path/to/credentials.json
ingress:
  - hostname: <DOMAIN_NAME_HERE>
    service: http://<INSTANCE_IP_ADDRESS>:<PORT_NUMBER>
  - service: http_status:404
sh
cloudflared tunnel route dns <TUNNEL_NAME> {YOUR_DOMAIN_HERE}.{COM/NET/ORG}
sh
cloudflared tunnel run <TUNNEL_NAME>

INFO

Please ensure that your instance ip address to reachable from your machine. For local testing, use 127.0.0.1

Now you should be able to access your AtmosphericX instance by going directly to the tunnel you created. By default, CF will not cache anything AtmosphericX. If you wish for interface intructions, please refer to Cloudflare's documentation for more information.