Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.astradial.com/llms.txt

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

​
Before you begin

You need Docker installed on your machine. If you don’t have it:

​
Step 1: Download Astradial

Open your terminal and clone the repository: 
git clone https://github.com/astradial/astradial.git
cd astradial

​
Step 2: Run the setup script

bash setup.sh
The script will ask you one question: 
Are you running on a Linux server or VPS? (y/n)

  y = Linux/VPS — full self-hosted setup
  n = Mac/Windows — connect to Astradial Cloud
Type y and press Enter.The script will ask for your admin credentials:
Set up your admin account:
  Email [[email protected]]: [email protected]
  Password [admin]: your-secure-password
  Name [Admin]: Your Name
Remember these credentials. You will use them to log into the dashboard.
Then it runs 5 steps automatically:
  1. Building Docker images — Downloads and builds all 7 services (takes 3-5 minutes on first run)
  2. Starting database — Starts MariaDB and Redis
  3. Starting Asterisk PBX — Starts the phone system engine
  4. Starting API, Dashboard, and AI Gateway — Starts the web services
  5. Finishing — Deploys the initial Asterisk configuration
When complete, you will see:
╔══════════════════════════════════════════════════════════╗
║  Astradial is ready!                                     ║
║                                                          ║
║  Dashboard:  http://localhost:3001                        ║
║  Login:      [email protected] / your-password       ║
║  SIP:        your-server-ip:5060                          ║
╚══════════════════════════════════════════════════════════╝

​
Step 3: Open the dashboard

Go to http://localhost:3001 in your browser. You will see the login page with two tabs:

​
For admin login (self-hosted)

  1. Click the Admin tab
  2. Enter the email and password you set during setup
  3. Click Sign In
You are now logged in as the system administrator. You can create organizations, manage users, and configure everything.

​
For organization user login

If you are not the admin, but a user of an organization:
  1. Stay on the Organisation tab
  2. Enter your email and password
  3. Click Sign In
Don’t have an account yet? Click Create Account on the login page. After registering, you can request to join an organization. The admin will approve your request.

​
Step 4: Create your first organization

If you logged in as admin:
  1. Click Create Organisation button on the admin dashboard
  2. Fill in the organization name
  3. The organization is created and you can click on it to enter the dashboard
If you logged in as a regular user:
  1. After login, if you have no organization, you will see a form
  2. Fill in your organization details:
    • Organisation Name (required)
    • Phone (required)
    • Industry — select from the dropdown
    • Company Size — how many people work at your company
    • Expected Users — how many people will use the phone system
    • Tell us what you need — describe your use case
  3. Click Submit Request
  4. Wait for the admin to approve your organization

​
What’s next?

Once you are inside your organization dashboard:

Explore the dashboard

Learn what each section of the dashboard does

Add your first user

Create a SIP extension so you can make and receive calls