User manual / Hotspot

Hotspot and vouchers

Sell WiFi by the hour or day: set up hotspot plans, generate and manage vouchers, design the splash page, and see who bought what.

Owners & adminsCustomer careTechnicians
All guides
On this page

How the hotspot works#

A hotspot is WiFi that people pay for in small bundles, such as an hour, a day or a week. When a guest joins your WiFi, your router shows them your splash page (also called the captive portal). They pick a bundle and pay with M-Pesa, or type a voucher code. CoreSync then lets that device online for as long as the bundle lasts.

Hotspot guests are not subscribers. They don't get an account in Subscribers, and they don't get monthly bills. CoreSync remembers them by phone number and device instead.

Everything lives under Hotspot in the Services part of the menu:

PageWhat it's for
DashboardWho is online now, today's and this month's hotspot money, and recent vouchers.
VouchersGenerate codes, print or SMS them, and pause, edit or revoke them.
SessionsEvery purchase and voucher use: which device, which plan, when it ends.
CustomersRepeat buyers, with their purchases and lifetime value.
Splash PageThe design and wording of the page guests see before they connect.
AdsYour own ad campaigns on the splash page, and free access for watching an ad.

Hotspot bundles themselves are plans, made on the Plans page. Hotspot settings are in Settings → Hotspot.

Set up a hotspot router#

Before anyone can buy, CoreSync has to set the hotspot up on your MikroTik router. You do this once per router.

  1. Add the router. On the hotspot Dashboard, press Add Device. You can also add it from Devices → All Devices. Choose Hotspot / PPPoE Router, and under Services this device handles pick Hotspot (and PPPoE too if the same router serves home customers). See Devices, OLTs and ONUs for the full wizard.
  2. Open the router's page and go to the NAS Setup tab. In Auto Provision Router, choose the Service (Hotspot, or Hotspot + PPPoE). Tick Configure WiFi during provisioning and fill in the SSID and Password if you want CoreSync to set the WiFi name too. Press Provision.
  3. CoreSync reads the router first. Pick the LAN Interface guests connect to and the WAN Interface that goes to the internet.
  4. Press Provision hotspot. CoreSync sets up RADIUS, the hotspot server, the walled garden and your login page on the router, and shows each step as it goes.
Provisioning changes the live router. Do it at a quiet time, and make sure the router is connected to CoreSync over the management tunnel first. See Routers, RADIUS and sessions.
Permission needed:Create Network DevicesEdit Network Devices

The hotspot dashboard#

The dashboard is the hotspot at a glance. It updates itself every 30 seconds, or press Refresh.

  • Active Sessions: devices online on the hotspot right now, and how many sessions started today.
  • Today's Revenue and Monthly Revenue: hotspot money for today and this month.
  • Data Consumed Today: how much data hotspot guests used today.
  • Recent Vouchers: the latest vouchers with plan, amount, phone, devices used and expiry, active ones first.
The hotspot dashboard with active sessions, today's revenue, data used and a list of recent vouchers
Permission needed:View Hotspot Dashboard

Hotspot plans (packages)#

Each bundle you sell is a plan with the type Hotspot. Guests see your hotspot plans on the splash page, with their prices.

  1. Open Plans (under Subscribers in the menu) and press Add Plan.
  2. Fill in the Plan Name and Plan Code, and set Plan Type to Hotspot.
    The new plan dialog with Plan Type set to Hotspot, showing validity, data limit and max devices
  3. Pick a Speed Profile. Then set how long it lasts: a Validity Unit (minutes, hours, days, weeks or months) and an Amount, for example 1 and Hours.
  4. Optional: a Data Limit (MB) (1000 MB = 1 GB; leave it empty for unlimited), and Max Devices, the number of devices that can use one purchase at the same time.
  5. For a data-only bundle, leave the duration empty and set a data limit instead.
  6. Tick Trial plan (one-time use per device) for a free taster. Each device can use it once.
  7. Set the Price and press Create Plan.

Plans in general (speed profiles, zones, editing and archiving) are explained in Plans and speed profiles.

Permission needed:View Service PlansCreate Service PlansEdit Service Plans

Generate vouchers#

A voucher is a code someone types on the splash page instead of paying there. Use vouchers for cash sales, resellers, events, schools and offices.

  1. Open Hotspot → Vouchers and press Generate.
  2. Choose the Plan (access duration) and the Hotspot device (the router the codes are for).
    The Generate vouchers dialog with plan, hotspot device, how many, redeemable days and device options
  3. Type How many codes you want (1 to 500) and Redeemable for (days): how long people have to use a code for the first time.
  4. Optional: Devices per code (leave blank to use the plan's limit) and a Label / notes such as "Church event", so you can find the batch later.
  5. Choose When access ends. Plan duration, from first use starts the clock when someone first connects. On a specific date stops every code in the batch at the end of the Last day of access, whenever they started.
  6. Turn on Reusable device slots if holders may change devices, for example students with a term-long code. You can then set Auto-free after (hours idle) and Issued to.
  7. Press Generate with the number, for example Generate 20.
Validity is not the bundle length. The plan decides how much access each code gives. Validity only decides how long the code can still be used for the first time. A 1-hour plan valid for 10 days gives each holder their hour whenever they first connect within those 10 days.
Without reusable slots, a device spends a slot for good. If a holder replaces their phone, the old phone keeps the slot and you can't free it. Turn on reusable slots for long-running codes.
Permission needed:View Hotspot VouchersGenerate Hotspot Vouchers

Print, copy or SMS vouchers#

Right after you generate a batch, CoreSync shows all the codes. From there:

  • Print opens a printable sheet of the batch, four codes to a row, ready to cut out.
  • Copy all copies every code, so you can paste them into a spreadsheet or message.
  • For a batch of 10 codes or fewer, type a Customer phone and press Send to text the codes straight to them.

Later, to send one code by SMS, open the menu at the end of its row and choose Send via SMS. Check the Phone number, edit the Message if you like, and send. The counter under the message shows how many SMS it will take.

SMS needs an SMS provider. If none is set up, CoreSync tells you and won't send. Set one up in Settings → Notifications. See Settings.
A voucher code is free internet. Treat printed sheets like cash, and don't post codes in group chats.

Export at the top of the Vouchers page downloads the voucher list as a spreadsheet file (CSV), including codes, labels and batches.

Permission needed:Generate Hotspot VouchersManage Hotspot Vouchers

Find and manage a voucher#

The cards at the top of the Vouchers page count the codes on the page you're looking at by status: Unused, Active, Paused, Expired and Revoked. The line above the table shows how many are listed and the total, for example 25 shown · 356 total. Search by code, plan, phone or batch, or filter by Status. The status filter also works on the loaded page only, so raise Rows per page if a code you expect is missing.

The Vouchers page with status counts, a search box and a list of voucher codes with plan, status and devices

Open the menu at the end of a row for these actions:

ActionWhat it does
Copy codeCopies the code.
Send via SMSTexts the code to a phone number.
Devices on this codeLists the devices that used the code. With reusable slots, Free slot disconnects a device and frees its place.
Record paymentNotes an M-Pesa reference, amount and phone against the code, for a customer who paid but never got their code. It labels the voucher only; it doesn't record a payment anywhere else.
Edit voucherChange the label, holder, customer phone, device limit, redeem-by date and when access ends. Save & send SMS also texts the holder.
Pause voucherStops the code at once and disconnects anyone on it. Their remaining time is kept.
Reactivate voucherStarts a paused code again, with the time it had left.
Revoke voucherEnds the code for good. If devices are on it, choose Revoke only or Revoke + disconnect.
The Devices on this code dialog listing a device with its MAC address, when it connected and a Free slot button
Pause, don't revoke, when you might change your mind. A paused code can be reactivated with its time intact. A revoked code is finished. If the voucher has a customer phone, CoreSync texts them when you pause or reactivate it.

An expired code can come back: in Edit voucher, set a future date in Expires at (or Access ends on) and save. CoreSync updates RADIUS as well.

Permission needed:View Hotspot VouchersManage Hotspot Vouchers

Hotspot sessions#

Hotspot → Sessions lists every hotspot purchase and voucher use: the device's MAC Address, the Router, the Plan, how they paid, the Amount, and when it was activated and expires.

  1. Search by MAC or IP, or filter by Status (Active, Expired, Revoked), by Router, and by date with From and To.
  2. To cut a device off, open the row menu and choose Disconnect Session, then Disconnect.
Disconnect ends the purchase. It revokes the session: the device is kicked off and its login is removed, so the guest loses whatever time they had left. Only do it for abuse or a refund you've agreed.

Home (PPPoE) customers and hotspot guests online right now are also listed together on Active Sessions. See Routers, RADIUS and sessions.

Permission needed:View Hotspot SessionsManage Hotspot Sessions

Hotspot customers#

Hotspot → Customers shows the people behind the purchases. Each row has the customer, their phone, their Last device, the number of Purchases, their LTV (lifetime value: everything they've spent) and their Last purchase.

  • Repeat customer or Occasional: a customer becomes a repeat customer after a set number of successful purchases (5 unless you change it in Settings → Hotspot).
  • Current or Inactive: inactive customers have been archived after a long time without buying. Their history is kept.

Search by name, phone or MAC. Click a customer to see every purchase, with the reference, device, router and when the session ends.

The Hotspot Customers list with purchases, lifetime value and repeat customer tags
Permission needed:View Hotspot Customers

The splash page and your branding#

Hotspot → Splash Page is where you design what guests see. The Live preview on the right changes as you edit. Nothing reaches guests until you press Save changes.

The splash page editor with design choices on the left and a live phone preview on the right
  1. Which portal are you designing? Most ISPs have one portal, the default. If you run a second brand, press New portal, name it, then press Choose routers to pick the routers that show it. Every other router keeps showing the default.
  2. What is this page for? Choose Sell bundles to show your plans and prices, or Access codes only for campuses, schools and guest networks where people only type a code they were given.
  3. Pick a Design from the gallery.
  4. Under Show or hide, switch parts of the page on or off: speed, duration, device count, data limit, prices, the voucher box, trial badges, your logo, company name, tagline, footer and support phone.
  5. Under Arrangement, set the Bundle order and the Voucher box position.
  6. Under Text content, write your welcome title, subtitle, tagline, support phone and footer.
  7. Under Branding, set the Accent color and Upload a logo (or Use organization logo), or paste a Logo URL. Some designs also take a Background image URL.
  8. Press Save changes.

Other options on the same page:

  • Access code page (Access codes only): the heading guests read, Require guests to accept terms, Remember devices, Ask guests to name their device, and Notices such as help desk hours.
  • Connected page: show a "You're online" screen after guests connect, with an optional link.
  • Advertising: show your ads on this page. See the next section.
  • TV Hotspot Purchases: lets your staff buy hotspot plans for TV devices from the dashboard.
  • Voucher hold messages: the texts sent when you pause or reactivate someone's code.

Your organization logo itself is set in Settings → Organization.

Permission needed:View Hotspot Splash PageManage Hotspot Splash Page

Ads on the splash page#

Hotspot → Ads lets you run your own adverts on your splash and connected pages, for example for a partner shop.

  • Run my own ads: show campaigns you created.
  • Carry CoreSync ads: off unless you switch it on. Nothing from CoreSync appears on your pages without it.
  • Allow free access for watching ads: lets guests earn free time by watching a video ad. Set Max free sessions per device per day so nobody farms free time.
  1. Press New campaign. Give it a Campaign name and an Advertiser (shown to guests as the ad's label).
  2. Under Where it runs, choose Splash banner, Rewarded video, Connected page or Success page. Set the Status, Starts, Ends and any view caps.
  3. For a rewarded ad, turn on Free access for watching and pick the Plan the reward grants, usually a short, capped plan.
  4. Save, then open the campaign's creatives and press Upload image or video.
Upload your images and videos to CoreSync rather than linking to another website. Guests can't reach outside sites until they're connected, so an outside image shows as broken.
Permission needed:View Hotspot AdsManage Hotspot Ads

Hotspot settings#

Settings → Hotspot controls how CoreSync tracks hotspot customers and what they can do. Change what you need and press Save hotspot settings.

Settings, Hotspot tab: customer tracking, retention and cleanup, and customer accounts switches
SettingWhat it does
Track successful paid hotspot purchasesBuilds the Customers list from paid purchases. It never creates a subscriber.
Purchases required for repeat customer statusHow many purchases make a repeat customer. 5 by default. It's a label for reports only.
Automatically archive inactive occasional customersMoves occasional buyers to Inactive after Archive after inactive days. Their history is kept.
Run cleanup every hoursHow often CoreSync checks for customers to archive.
Let hotspot buyers sign in to their WiFi accountLets buyers open My WiFi from the login page to see their bundles, move one to a new phone, add a device and get receipts.
Sign in with a code sent by SMSBuyers sign in with a code texted to the phone they paid with. Each sign-in costs you one SMS.
Let buyers pay for a bundle for another phone numberLets someone buy a bundle for a friend. The friend gets a text with the code.
Offer home internet to buyers with 5+ purchases (creates a CRM lead)Shows repeat buyers an offer for home internet. The number follows your repeat-customer setting. Saying yes creates a lead in your CRM.

The two message boxes set the SMS sent when someone buys a bundle while still online (it waits and starts when the current one ends), and the SMS sent to the person a bundle was bought for. Type - to send nothing.

Permission needed:View SettingsView Hotspot SettingsManage Hotspot Settings

How a customer buys with M-Pesa#

This is what happens on the guest's side. The full customer guide is Hotspot for customers.

  1. The guest joins your WiFi. Their phone opens your splash page by itself.
  2. They pick a bundle and type their M-Pesa number. An M-Pesa prompt appears on their phone.
  3. They enter their M-Pesa PIN. The splash page waits until the payment arrives.
  4. CoreSync receives the payment, lets that device online for the bundle, and the guest sees they're connected.

If the guest paid but wasn't connected, they can paste their M-Pesa confirmation SMS on the splash page and press Redeem & Connect. Each M-Pesa receipt can only be used once.

Hotspot payments use the M-Pesa gateway you set up in Settings → Payment. See Payments, and Hotspot for customers for the guest's view.

Walled garden basics#

Before a guest pays, the router blocks the internet. The walled garden is the short list of addresses they can still reach, so they can load your splash page and pay.

When CoreSync provisions a hotspot, it adds what it needs to the router's walled garden for you: your splash page, CoreSync's own services, RADIUS and DNS. You don't need to add these yourself.

  • If you link to something outside CoreSync on your splash page, such as your own website or terms, guests can't open it until they're online, unless it's in the walled garden.
  • Upload ad images and videos to CoreSync, for the same reason.
  • If guests can't even see the splash page, the router's hotspot setup is usually the problem, not the walled garden. Run the NAS health check (below).

Common mistakes#

  • Confusing validity with bundle length. "Redeemable for (days)" is how long a code can wait to be used. The plan sets how long it lasts once used.
  • Disconnecting a session to "refresh" a guest. It revokes the purchase and they lose their time. Pause the voucher instead if you need to stop it for a while.
  • Revoking when you meant to pause. A revoked code can't come back.
  • Generating twice. Each press of Generate makes a new batch. If a batch seemed not to appear, press Refresh before generating again.
  • Long-term codes without reusable slots. When a holder changes phone, the code runs out of slots.
  • Thinking Record payment adds money to your books. It only notes the payment on the voucher.
  • Leaving a new portal with no routers. No guest will ever see it. Press Choose routers.

If it doesn't work#

What you seeWhat to check
Guests join the WiFi but no splash page appearsOn the router's NAS Setup tab, press Run Health Check. Look at Hotspot Server and RADIUS Config, and use Fix if offered.
The splash page shows no bundlesYou need at least one active plan with Plan Type Hotspot.
A guest paid but isn't onlineSearch their phone or MAC in Sessions. If there's nothing, ask them to paste their M-Pesa message on the splash page and press Redeem & Connect.
A voucher says it's used upOpen Devices on this code. With reusable slots, use Free slot. Without them, issue a new code.
Voucher SMS won't sendSet up an SMS provider in Settings → Notifications, and check your SMS balance.
Your router shows offline in CoreSyncIts management tunnel is down. See Routers, RADIUS and sessions.

More help: Troubleshooting.

Still stuck? Open the AI assistant in CoreSync and describe what you see, or email hello@coresyncisp.com. Screenshots on this page come from Amani Link, our demo ISP, so the names and numbers are made up.