Skip to main content

First Login

After installing OPBX, you'll need to create your first organization and admin user. This guide walks you through the initial setup.

Accessing the Application

Open your web browser and navigate to:

http://localhost/ui
note

If you changed the port mapping during installation (e.g., 8080:80), use that port instead:

http://localhost:8080/ui

Creating Your Organization

OPBX uses a multi-tenant architecture. The first step is creating your organization (tenant).

Registration Form

You'll see the Create Organization registration form with the following fields:

Organization Information

FieldRequiredDescription
Organization NameYesYour company or organization name
TimezoneYesPrimary timezone for the organization

Admin User Information

FieldRequiredDescription
Full NameYesAdministrator's full name
EmailYesAdmin email address (used for login)
PasswordYesSecure password (min 8 characters)
Confirm PasswordYesMust match password

Step-by-Step Registration

  1. Enter Organization Name

    • Example: "Acme Corporation" or "My Company"
    • This identifies your organization in the platform
  2. Select Timezone

    • Choose your primary business timezone
    • This affects business hours and call logging
    • Example: America/New_York, Europe/London, Asia/Tokyo
  3. Create Admin User

    • Full Name: Enter the administrator's name
    • Email: Valid email address for login
    • Password: Strong password (recommended: 12+ characters with mixed case, numbers, symbols)
  4. Submit the Form

    • Click "Create Organization"
    • Wait for the system to initialize (10-20 seconds)

Registration Success

After successful registration, you'll be:

  • Automatically logged in as the admin user
  • Redirected to the OPBX Dashboard
  • Ready to start configuring your PBX
Registration Issues

If registration fails:

  • Check that all required fields are filled
  • Ensure passwords match
  • Verify email format is valid
  • Check browser console for errors
  • Review Docker logs: docker compose logs app

Dashboard Overview

After logging in, you'll see the main OPBX Dashboard:

MenuDescription
DashboardOverview and statistics
UsersManage organization users
ExtensionsConfigure phone extensions
Ring GroupsSet up hunt groups
Phone NumbersManage DIDs
IVR MenusCreate voice menus
Business HoursConfigure schedules
AI AssistantsSet up AI call handling
Call LogsView call history
SettingsOrganization configuration

Top Bar

  • Organization Selector: Switch between organizations (for platform managers)
  • Notifications: System alerts and messages
  • User Menu: Profile, settings, and logout

Security Hardening Checklist

After first login, complete these security steps:

Immediate Actions

  • Verify Admin Access

    • Confirm you can access all expected features
    • Check that role is "Owner" in User settings
  • Review Environment Variables

    • Ensure APP_URL is set correctly
    • Verify strong passwords are used
  • Configure Cloudonix (for VoIP functionality)

    • Go to Settings in the navigation
    • Enter your Cloudonix Domain UUID and API Key
    • See Cloudonix Integration for details
  • Enable HTTPS (Production)

    # Edit .env
    APP_URL=https://your-domain.com

    Configure SSL certificates in Nginx or use a reverse proxy.

  • Set Up Backups

    • Configure automated database backups
    • Set up call recording backups
    • Test restore procedures
  • Configure Firewall

    • Restrict access to admin panel by IP if needed
    • Block unnecessary ports
    • Enable fail2ban for SSH/brute force protection
  • Review User Permissions

    • Create additional users with appropriate roles
    • Don't share the admin account
    • Set up role-based access for different departments

Security Best Practices

  1. Strong Passwords

    • Minimum 12 characters
    • Mix of uppercase, lowercase, numbers, symbols
    • No dictionary words or personal information
    • Use a password manager
  2. Regular Updates

    • Keep OPBX updated to latest version
    • Update Docker images regularly
    • Apply security patches promptly
  3. Access Control

    • Limit admin access to necessary personnel
    • Use separate accounts for different roles
    • Enable audit logging
  4. Data Protection

    • Encrypt sensitive data at rest
    • Use HTTPS for all communications
    • Secure backup storage

Next Steps

Now that you're logged in and your organization is set up:

Cloudonix Integration
Configure the Cloudonix integration to enable phone calls, extensions, and VoIP features.

Basic Configuration

  1. Create Users
    Add additional users to your organization:

    • Navigate to UsersNew User
    • Assign appropriate roles (Admin, User, Reporter)
  2. Configure Extensions
    Set up phone extensions:

    • Go to ExtensionsNew Extension
    • Assign extensions to users
    • Configure voicemail
  3. Set Up Ring Groups (Optional)
    Create hunt groups for departments:

    • Navigate to Ring GroupsNew Ring Group
    • Add members
    • Select ringing strategy
  4. Configure Phone Numbers (Requires Cloudonix)
    Map DIDs to extensions or ring groups:

    • Go to Phone NumbersNew Phone Number
    • Enter DID and routing destination

Documentation & Help

  • Documentation: http://localhost/docs
  • API Reference: Available at /api endpoint
  • Logs: Check with docker compose logs -f

Troubleshooting

Cannot Access the UI

Problem: Browser shows "Connection refused" or "Site cannot be reached"

Solutions:

  1. Check containers are running:

    docker compose ps
  2. Verify frontend container is healthy:

    docker compose logs frontend
  3. Check if ports are correctly mapped:

    # Should show port 80 or your mapped port

docker compose port nginx 80


### Registration Form Errors

**Problem**: "Email already exists" or validation errors

**Solutions**:
1. If email exists, use the login page instead
2. Clear browser cache and cookies
3. Check for JavaScript errors in browser console

### Dashboard Loads But Shows Errors

**Problem**: API errors or missing data

**Solutions**:
1. Check API health:
```bash
curl http://localhost/api/health
  1. Verify database migrations ran:

    docker compose exec app php artisan migrate:status
  2. Check app logs:

    docker compose logs app

Getting Help

If you encounter issues:

  1. Check Documentation: http://localhost/docs
  2. Review Logs: docker compose logs
  3. GitHub Issues: github.com/opbx/opbx/issues

Welcome to OPBX! Your organization is now set up and ready to use. Continue to the Cloudonix pairing guide to enable VoIP functionality, or explore the dashboard to configure your PBX.