Skip to main content

Setup guide

The setup guide walks a company through everything a phone system needs, in 18 steps, from the licence to a final health check. Open it from System > Setup guide, or with Continue setup in the setup bar at the top of the admin Overview. The guide comes after the first-run wizard of the install (First run); it does not replace it.

The guide never configures anything by itself. Each step opens the normal page (or shows a small form that calls the same settings), and the guide only remembers how far you are.

How it works​

  • Progress. A bar shows how many steps are done and about how many minutes are left. The progress is saved for the whole company, so you can close the browser and continue later, or hand over to a colleague.
  • Required, recommended and optional. Required steps (licence, company, trunks, numbers, users and the final health check) cannot be skipped. Recommended and optional steps have Skip for now; a skipped step stays in the list and can be done later.
  • Who and when. A step you finish shows who marked it and when.
  • Several administrators. While an administrator has a step open, the others see "is editing this step". The marker only warns: it expires after two minutes without activity, and Take over replaces it.
  • Run again. Run the guide again sets every step back to to do and shows the dashboard card again. Nothing you configured is changed.
  • The setup bar. While steps remain, one line sits at the top of the admin Overview, under the title and above the live tiles: how many steps are done (for example "6 of 9 steps done"), a progress bar, the next step, and Continue setup, which opens that step. On a narrow screen the line wraps. The bar disappears by itself once every step is done. An administrator who may change settings can also Hide this card for the whole company; Show the dashboard checklist on the guide brings it back.

Each field has a ? button with a short explanation and a Learn more link that opens the matching documentation page in a new tab. Test buttons show a clear pass or fail and say how to fix a failure.

The steps​

#StepLevelWhat it does
1Licence or trialRequiredOpens the Licence page.
2Company and regionRequiredHome country, time zone, language, currency and number format (see below).
3Domain and certificateRecommendedThe PBX's domain name with a DNS check (see below).
4Business hours and holidaysRecommendedOpens the office hours and loads your country's public holidays (see below).
5TrunksRequiredProvider template or generic SIP, detect, test registration and call.
6Phone numbersRequiredAdd, paste or import numbers, default caller ID.
7Outbound rules and dial planRecommendedCountry preset, toll-fraud protection, dial pattern tester.
8Inbound routingRecommendedWhere each number's calls go, open and closed.
9Users and extensionsRequiredOne by one or CSV, with extensions.
10Phones and appsRecommendedApp QR code, desk phones, test call.
11SMS and channelsOptionalProvider, number, test message.
12E-mailRecommendedProvider or relay, test e-mail.
13CRM and integrationsOptionalTest connection, screen-pop preview.
14AI featuresOptionalKeys, features, consent, try it.
15Recording, storage and backupsRecommendedPolicy, destination, test backup.
16SecurityRecommendedSecond factor, allow-list, sign-in alerts.
17Invite the teamOptionalMail preview, everyone or selected, QR code.
18Final health checkRequiredCheck or cross per area, test call.

Steps 5 to 18 each have a short form for the common case and a link to the full page for everything else. Every step shows a check or a cross in words for its area, read from your own configuration (for example "2 trunks, 1 outbound" or "no number points anywhere yet") and what to fix. See Steps 5 to 18 below.

Step 2: company and region​

Choose the home country. The guide suggests the country's main time zone, currency, number format and a product language; change any of them. Saving sets the company's home country, time zone, language, currency and number format, and they apply at once:

  • Language: the company language is used for e-mails, voice prompts and new users, and the console and the MonoPhone app start in it for anyone who has not picked a language of their own (a person's own choice always wins; MonoPhone follows the phone's language when the app has it).
  • Number format (1,234.56, 1.234,56 or 1 234,56): every number in the console and in MonoPhone uses these separators, whatever language each person reads in. Leave it as suggested to follow the country.
  • Currency: amounts without a currency of their own (new SMS price lists, call cost settings, campaigns, ad conversion values) start in it, and amounts are shown with it.

You can come back to the step at any time to change them. The company name and logo are set on the Branding page. A country with several time zones gets its main one: change it if your office is elsewhere.

Step 3: domain and certificate​

Enter the host name of the PBX (for example the name your phones will use). Check DNS looks the name up and reports:

  • no address yet: add an A record (and AAAA for IPv6) at your DNS provider and wait a few minutes;
  • private address only: phones outside your office cannot reach it;
  • points to another server: the name does not lead to the web address you are using now.

The check changes nothing. When the name resolves, request a certificate on the Certificates page.

Step 4: business hours and holidays​

Set the opening hours on the Office hours page. The guide then offers the public holidays of your home country: fixed days (repeating every year), days that fall on the n-th weekday of a month, and days that follow Easter (dated for this year and the next). Untick what you do not want, name the calendar and load it. Regional and one-off days are not included: add them on the holidays page or import an iCalendar file. The list is built into the product and no outside service is asked. It covers Mexico, the United States, Canada, the United Kingdom, Germany, France, Spain, Italy, Portugal, Brazil, Argentina, Colombia, Chile, Peru, the Netherlands, Belgium, Austria, Switzerland, Australia and Ireland; for other countries import a calendar file.

Steps 5 to 18​

Each step uses the normal configuration, so everything you set here also appears on the regular pages.

  • 5 Trunks. Start from a provider template or a generic SIP trunk. Detect looks the provider's host up (SIP service records, then A and AAAA), and suggests the transport, the port and the codec order for your country, and tells you whether the PBX looks to be behind NAT. Test registration and Test call show a pass or a fail with how to fix it.
  • 6 Phone numbers. Add numbers one by one, paste a list or import a CSV file, attach them to a trunk and choose the default caller ID.
  • 7 Outbound rules and dial plan. Create the standard rules for your home country's calling code (the step needs the country from step 2). International calls are off unless you tick Allow international calls, and one button blocks the high-risk destinations. Try a number in the dial pattern tester before saving.
  • 8 Inbound routing. For each number, a small diagram shows what happens during open hours, closed hours and the voicemail fallback.
  • 9 Users and extensions. Add people one by one or import a CSV file (with their extensions), and see links to departments, single sign-on and directory sync.
  • 10 Phones and apps. Your own MonoPhone QR code, desk phone auto-provisioning, the browser phone and a test call between two extensions.
  • 11 SMS and channels. Add a provider and number and send a test message.
  • 12 E-mail. Use your own mail provider, or the built-in relay (its sending limits are explained) and send a test e-mail.
  • 13 CRM and integrations. Test each connection and preview the screen pop.
  • 14 AI features. Your own keys, the call assistant, live captions and summaries, whether callers are told first, and a try-it.
  • 15 Recording, storage and backups. The recording policy, where recordings go, and (for the install administrator) the backup schedule and a test backup.
  • 16 Security. Your own second factor, two-factor sign-in for everyone, an IP allow-list for administrators and sign-in alerts.
  • 17 Invite the team. See who has not signed in yet, preview the invitation e-mail exactly as they will get it, send it to everyone or to selected people, and show a QR code for the app.
  • 18 Final health check. A check or a cross for every area, the company health report, the steps you skipped, and Make a test call now.

Test buttons report in words (and never by colour alone). The guide keeps only counts of how often a step was skipped and a Test button failed, on your own server (see below).

Templates​

At the top of the guide pick what fits your business: Small office, Contact centre, Hotel, Clinic or Multi-branch. The template skips the optional steps you do not need (it never skips a required step or one you finished) and starts the forms with sensible defaults. Choosing a template configures nothing, and you can change or clear it at any time. Coming from another phone system? The guide links to Move from another PBX for importing users, extensions, groups, queues, menus and numbers.

Hand one step to a technician or a managed service provider for a limited time. Choose the step, the person's e-mail, a role of your company and how long it lasts (1 to 168 hours). They receive a support account with that role and a single-use link to choose their password, and the link opens the step. The account is hidden from the directory and does not use a licence seat. You can only give a role that has no permission you do not have yourself. When the time is up, or when you Revoke the link, the account is switched off at once. Creating and ending links is recorded in the audit log.

Local step statistics​

The guide counts, on your server only, how often each step was skipped and how many Test buttons ran and failed (with the last failure code). Nothing is sent anywhere. Administrators with settings access see them on the guide.

For integrators​

The guide is also available over the API (tag Setup guide): GET /setup-guide, PUT /setup-guide/steps/{key}, POST /setup-guide/steps/{key}/editing, PUT /setup-guide/dismissed, POST /setup-guide/reset, and the helpers GET /setup-guide/region, GET /setup-guide/holidays POST /setup-guide/dns-check, GET /setup-guide/checks (one check per area), GET /setup-guide/templates and PUT /setup-guide/template, POST /setup-guide/trunk-detect, POST /setup-guide/steps/{key}/test-result with GET /setup-guide/analytics, and the technician links GET/POST /setup-guide/links, GET /setup-guide/steps/{key}/links and POST /setup-guide/links/{id}/revoke. The regional formats themselves are GET/PUT /company-region (language, currency, number_format), and every signed-in person receives them in GET /me (region). Reading needs settings:read; everything else needs settings:write.