UGspot
Documentation

Step-by-Step Guide

Everything you need to get started with UGspot

Getting Started

Welcome to UGspot! This guide will help you set up your WiFi hotspot business step by step. Follow these simple steps to get started.

What You Need:
  • A MikroTik router with hotspot configured
  • Your MikroTik router's IP address and login details
  • Basic understanding of WiFi hotspot operations

Step 1: Create Your Account

1

Go to Registration Page

Click the "Register" button on the homepage or go to the registration page.

2

Fill in Your Details

Enter the following information:

  • Full Name: Your complete name
  • Email Address: A valid email you can access
  • Phone Number: Your mobile phone number
  • Password: Choose a strong password (at least 8 characters)
  • Confirm Password: Type your password again
3

Submit and Verify

Click "Register" button. You will receive a confirmation email. Check your email and click the verification link to activate your account.

Success! Once your account is verified, you can log in and start setting up your business.
Go to Registration

Step 2: Setup Your Network

A network represents one WiFi hotspot location. You can have multiple networks (e.g., different locations) and manage them all from one dashboard.

1

Go to "My Networks"

After logging in, click on "My Networks" in the sidebar menu.

2

Click "Add New Network"

You will see a button to add a new network. Click it to open the network creation form.

3

Enter Network Information

Fill in the details:

  • Network Name: Give your network a name (e.g., "Main Office WiFi", "Shop Location 1")
  • Contact Phone: Phone number for customer support
  • Location Note: Address or description of where this network is located
  • Logo (Optional): Upload your business logo to show on the hotspot login page
4

Save Your Network

Click "Save Network" to create it. You can create multiple networks if you have more than one hotspot location.

Tip: You can switch between networks anytime using the network selector in the header. Each network has its own vouchers, packages, and reports.

Step 3: Configure MikroTik Router

This is the most important step. You need to connect UGspot to your MikroTik router so it can manage your vouchers.

1

Go to "MikroTik Settings"

Click on "MikroTik Settings" in the sidebar menu.

2

Select Your Network

Choose the network you want to configure from the dropdown menu at the top.

3

Choose Connection Type

You have two options:

  • Direct Connection: If your MikroTik router is on the same network or accessible directly
  • VPN Connection: If your router is in a remote location and connected via VPN
4

Enter Router Details

Fill in your MikroTik router information:

  • Router IP Address: The IP address of your MikroTik router (e.g., 192.168.1.1)
  • Port: Usually 8728 (default MikroTik API port)
  • Username: Your MikroTik router username (usually "admin")
  • Password: Your MikroTik router password
  • Connection Name: Give this connection a name (e.g., "Main Router")
5

Test Connection

Click "Test Connection" to make sure UGspot can connect to your router. You should see a success message if everything is correct.

6

Save Configuration

Once the connection test is successful, click "Save Configuration" to save your settings.

Important: Make sure your MikroTik router's API service is enabled. You can check this in your router's settings under "IP" → "Services" → make sure "api" is enabled.
Need Help? If you're having trouble connecting, check:
  • Your router's firewall allows connections on port 8728
  • The IP address is correct and reachable
  • Your username and password are correct
  • The API service is enabled on your router

Step 4: Create Packages

Packages are the internet plans you sell to customers. Each package has a price, duration, and data limit.

1

Go to "Packages"

Click on "Packages" in the sidebar menu.

2

Click "Add New Package"

You will see a form to create a new package.

3

Fill in Package Details

Enter the following information:

  • Package Name: A clear name (e.g., "1 Hour - 500MB", "Daily - Unlimited")
  • Price: How much customers will pay (in UGX)
  • Duration: How long the internet lasts (e.g., "1h" for 1 hour, "24h" for 24 hours, "7d" for 7 days)
  • Data Limit: How much data customers can use (e.g., "500M" for 500MB, "2G" for 2GB, "unlimited" for no limit)
  • Description: Optional description of what this package includes
4

Save Package

Click "Save Package" to create it. You can create as many packages as you need.

Example Packages:
  • 5Hrs: UGX 500
  • Daily: UGX 1,000
  • Weekly: UGX 5,000
  • Monthly: UGX 20,000

Step 5: Create User Profiles (Advanced)

User profiles control how vouchers work on your MikroTik router. They set time limits, data limits, and prices. This step is important for accurate earnings tracking.

1

Go to "Packages" Page

Scroll down to the "MikroTik User Profiles" section on the Packages page.

2

Click "Add New Profile"

You will see a form to create a new profile.

3

Enter Profile Details

Fill in the profile information:

  • Profile Name: Name that matches your package (e.g., "1Hour", "Daily", "Weekly")
  • Shared Users: How many users can use this profile at once (usually 1)
  • Rate Limit: Speed limit (e.g., "2M/2M" for 2Mbps upload/download)
  • Address Pool: Select from dropdown (usually "none" or your hotspot pool)
  • Expired Mode: Choose what happens when voucher expires:
    • Remove: User is removed when expired
    • Notice: User is notified but not removed
    • Remove & Record: User is removed and sale is recorded (for earnings tracking)
    • Notice & Record: User is notified and sale is recorded
  • Validity: How long the voucher lasts (e.g., "1h", "24h", "7d")
  • Price: The price of this profile
  • Selling Price: Optional different selling price
4

Save Profile

Click "Save Profile". The system will automatically create scripts in your MikroTik router to track sales and remove expired users.

Important: For earnings tracking to work, you MUST use "Remove & Record" or "Notice & Record" mode. This creates scripts that track when vouchers are sold.
Good to Know: The system automatically creates a scheduler in your MikroTik router that removes expired users. You don't need to do anything else - it works automatically!

Step 6: Generate Vouchers

Now you're ready to create vouchers! Vouchers are the codes customers use to connect to your WiFi.

1

Go to Dashboard

On your dashboard, you will see a card that says "Generate Vouchers". Click on it.

2

Select Package

Choose which package you want to create vouchers for from the dropdown menu.

3

Enter Quantity

Type how many vouchers you want to create (e.g., 10, 50, 100).

4

Click "Generate"

The system will create the vouchers and add them to your MikroTik router automatically. You will see a list of all generated vouchers with their codes and passwords.

5

Print or Export

You can:

  • Print: Click "Print" to print vouchers in a nice format
  • CSV: Click "CSV" to download vouchers as a spreadsheet file
Tip: You can generate vouchers in bulk (100, 500, 1000 at once) to save time. Each voucher will have a unique code and password.

Step 7: Manage Your Vouchers

The Vouchers page lets you view, search, delete, and manage all your vouchers.

1

Go to "Vouchers"

Click on "Vouchers" in the sidebar to see all your vouchers.

2

View Vouchers

You will see a table showing:

  • Voucher code (username)
  • Password
  • Profile (package type)
  • Time limit
  • Data limit
  • Status (active, used, expired)
3

Search Vouchers

Use the search box to find specific vouchers by code, comment, or profile.

4

Bulk Actions

You can:

  • Select Multiple: Check boxes to select multiple vouchers
  • Delete Selected: Remove multiple vouchers at once
  • Print Selected: Print multiple vouchers together
  • Search by Comment: Find vouchers by comment, then delete or print them
Note: When you delete vouchers, they are removed from both the database and your MikroTik router.

Step 8: View Reports & Earnings

Track your business performance with real-time statistics and earnings reports.

Dashboard Statistics

1

View Real-Time Stats

On your dashboard, you can see:

  • Hotspot Active: Number of users currently connected
  • Hotspot Users: Total number of users in your router
  • Vouchers Sold Today: How many vouchers were activated today
  • Earned Today: How much money you made today

Earnings Tracking

2

Check Earnings

In the header, you will see "Earned Today". Click the dropdown arrow to:

  • View earnings for yesterday
  • View earnings for this month
  • View earnings for last month
  • Select a specific date
  • Select a specific month
How Earnings Work: Earnings are calculated from MikroTik scripts created when customers activate vouchers. Each script represents one voucher sale. The system automatically tracks this for you!

Hotspot Logs

3

Monitor Activity

On your dashboard, you can see the "Hotspot Log" table showing:

  • Time of activity
  • User IP address
  • Activity messages (logins, failures, etc.)

This updates automatically so you can see what's happening in real-time.

Common Questions

How do I know if my MikroTik is connected?

On your dashboard, look at the top right. You will see "MikroTik Connected" in green if connected, or "MikroTik Disconnected" in red if there's a problem. You can also check in "MikroTik Settings" page.

Why are my earnings showing 0?

Earnings are calculated from MikroTik scripts. Make sure:

  • Your user profiles use "Remove & Record" or "Notice & Record" mode
  • Customers have activated vouchers today
  • Your MikroTik router is connected and working

Earnings update automatically when customers buy and activate vouchers.

Can I have multiple networks?

Yes! You can create as many networks as you need. Each network can have its own:

  • MikroTik router connection
  • Packages and profiles
  • Vouchers
  • Reports and earnings

Switch between networks using the dropdown in the header.

How do customers buy vouchers?

When customers try to connect to your WiFi, they will see a login page. On that page, they can:

  • See all available packages
  • See prices for each package
  • Click "Buy" to purchase a voucher
  • Pay using mobile money
  • Get their voucher code and password automatically

They can then use that code to connect to your WiFi.

What happens when a voucher expires?

It depends on your profile settings:

  • If you set "Remove" mode: The user is automatically removed from the router
  • If you set "Notice" mode: The user gets a notification but stays connected
  • If you set "Remove & Record": The user is removed and the sale is recorded for earnings

The system has a scheduler that checks and removes expired users automatically - you don't need to do anything!

Can I upload vouchers from a file?

Yes! Go to "Upload Vouchers" in the sidebar. You can upload a CSV file with voucher codes and passwords. The system will add them to your MikroTik router automatically.

How do I change my password?

Go to "Profile" in the sidebar menu. You will see a section to change your password. Enter your current password and your new password, then save.

What if I forget my password?

On the login page, click "Forgot Password". Enter your email address and you will receive instructions to reset your password.

Ready to Start?

Follow these steps and you'll be up and running in no time!