Admin panel

How to turn on the admin panel

How to turn on the admin panel

In TeleportHQ, you turn on the admin panel from the editor's left sidebar: click Plugins, click Admin panel, click the Admin panel enabled switch, then click Activate Admin Panel. Authentication must be on first. A checklist shows each step while TeleportHQ builds a dashboard, list, create and edit pages for each kind of data in your project, and the workflows behind them. Every admin page is open only to users with the admin role.

Before you start

  • Turn on authentication. The admin panel is built on your site's user accounts. Until authentication is on, the Admin panel enabled switch is greyed out. See How to add sign-up and login to your site.
  • Your project is a web app by then. Turning on authentication already made it one. If an older project still opens an Enable Web App features? window, click Enable Web App features to go on. See What is a web app in TeleportHQ?.
  • Stores and booking sites may already have one. Projects created with the E-commerce card, AI-built web apps that sell products, and projects where Bookings is turned on get an admin panel automatically. In Plugins, the Admin panel row then reads On.

Steps

  1. Open your project in the TeleportHQ editor.
  2. In the left sidebar, click Plugins (the four-squares icon above Growth).
  3. Click the Admin panel row. It shows Off. Its settings open in a drawer beside the list.
The TeleportHQ Plugins panel with the Admin panel row, marked Off, highlighted
  1. Under Feature, click the Admin panel enabled switch. The Activate Admin Panel window opens. Under What will happen: it lists a dashboard with overview charts, list, create and update pages for each kind of data, sidebar navigation, an admin header with sign-out, admin role protection, the workflows behind the pages, and Pages for building standalone pages.
  2. Click Activate Admin Panel.
The TeleportHQ Activate Admin Panel window with the What will happen list and the Activate Admin Panel button highlighted
  1. If your project has no database yet, the window asks which one to use. TeleportHQ database is selected. Click Continue.
  2. A checklist titled Setting up your admin panel shows each step: Preparing the database, Building the admin pages, Translating the admin pages (only on a project with several languages and automatic translation on) and Finishing up. Keep the tab open: "Each step is saved as it completes." After a minute you can click Continue in background and keep working.
  3. When the title reads Your admin panel is ready, click Open the dashboard. The admin dashboard page opens on the canvas.
  4. A window titled Admin Panel is Ready! offers a short tour. Click Show Me to take it, or Maybe Later.

Check that it worked

  • A message says "Admin panel enabled successfully with N pages including dashboard, CRUD (Create, Read, Update, Delete) operations, and workflows."
  • In Plugins, the Admin panel row reads On.
  • In Pages, Components & Tree View, the admin-panel folder holds the dashboard page and a folder for each kind of data, such as users, assets and sent-emails.
The TeleportHQ Pages list with the admin-panel folder open, showing the dashboard page and a folder for each kind of data

To use the admin panel, publish your site and create a user with the admin role. See How to open the admin panel on your live site.

Update or rebuild the admin pages

TeleportHQ can rebuild every admin page with the latest layout, fields and navigation:

  • Older admin panels show a blue Update button on the admin-panel folder: "A newer product screen is available for your admin panel: variants and options are edited on each product." Click it.
  • Any admin panel: right-click the admin-panel folder and click Regenerate Admin Panel.

The Update Admin Panel Pages window lists What will happen: and warns: "This will recreate all admin panel pages. Any manual customizations to admin pages will be lost." Click Regenerate Pages to go ahead, or Cancel.

The TeleportHQ Update Admin Panel Pages window with its list of changes, the warning about manual changes and the Regenerate Pages button

TeleportHQ also offers a rebuild on its own when you add a language to a project with a store or a blog (the product and post pages get translation fields), and asks Dashboard will be regenerated when a feature change would replace a dashboard you edited: click Keep My Changes or Apply Changes.

Turn the admin panel off

  1. In the left sidebar, click Plugins, then the Admin panel row.
  2. Under Feature, click the Admin panel enabled switch.
  3. The Disable Admin panel window says "This deletes the admin-panel folder and every page in it, including any changes you made to those pages. The data they managed stays in your data source." Click Disable Admin panel.

A message says "Admin panel has been disabled for this project". The admin-panel folder and its pages are gone from your page list, and the Admin panel row in Plugins reads Off. Publish again to remove the admin pages from your live site. The window warns that this can't be undone. Turning the admin panel on again builds fresh admin pages, without your earlier changes.

Troubleshooting

The switch is greyed out and says "Turn on Authentication first." The admin panel needs sign-in. Turn on Authentication in Plugins first, then come back to the Admin panel row.

The TeleportHQ Admin panel settings with the Admin panel enabled switch greyed out and the note Turn on Authentication first

"Cannot activate Admin Panel: Authentication has been disabled. Please re-enable Authentication first." Authentication was turned off while the window was open. Turn it on again, then repeat the steps.

"Your admin panel could not be set up" "Something went wrong. Nothing was left half-done." Close the checklist and turn the admin panel on again from Plugins → Admin panel.

"Custom Pages could not be set up. The admin panel is ready; open it again later to retry." The admin panel works, but its Pages section failed to set up. See How to build your own admin pages from blocks.

"Regenerating from here would delete the admin pages of …: they were added by another collaborator or by hand." Someone else added tables to this admin panel. Ask them to run the update.

The Update button or Regenerate Admin Panel is missing The Update button only shows on admin panels built before the current product screen. Both it and Regenerate Admin Panel delete and create pages, so your role must be allowed to do both. Ask the project's owner.

Good to know

  • You can design the admin pages in the editor like other pages, but a rebuild replaces your changes.
  • Show proposed plugins (Project settings → Editor → Preferences → Editing) adds a dashed admin-panel folder to the Pages list when the admin panel is off. Its Activate button opens the same Activate Admin Panel window.
Share

Related Articles

What is the admin panel?

The TeleportHQ admin panel is a back office that TeleportHQ builds for your web app at /admin/dashboard on your published site, where people with the admin role manage users, orders, products, bookings, invoices, blog posts and comments, files, sent emails and your own database tables, and build extra pages from blocks, without opening the editor.

How to add sign-up and login to your site

In TeleportHQ, you add sign-up and login by clicking the Authentication (padlock) button at the top left of the canvas, or Plugins → Authentication in the left sidebar, and following the Activate Authentication steps; TeleportHQ creates the sign-in, sign-up, password and profile pages, keeps the accounts in a database and makes your site a web app.

How to open the admin panel on your live site

In TeleportHQ, the admin panel of your published web app is at your site address followed by /admin/dashboard (for example https://mybakery.teleporthq.app/admin/dashboard); the Publish window shows the link under "Admin panel is included", and you sign in with an account whose role is admin, which you can create with Create admin user.

How to manage a database table from the admin panel

In TeleportHQ, you add any database table (for example a Leads or Menu table) to your admin panel from the Manage Entities window, opened with Plugins → Admin panel → Manage in the left sidebar: pick the table, set its Entity Label, Sidebar Section and Columns, and click Add to Admin Panel; you can also add it from the table's menu in the Data Sources panel.

How to turn features on or off (Plugins)

In the TeleportHQ editor, click Plugins in the left sidebar, click a plugin such as Blog, Bookings or Authentication, and flip its "enabled" switch in the drawer that opens; the same drawer starts its tutorial, opens its panel, shows or hides its left-sidebar button and lists what needs attention, and flipping the switch again and confirming turns it off.

How to manage your site's users and roles

In TeleportHQ, you manage the people who have accounts on your web app from the Users tab of the authentication window (padlock button → Manage Settings & Users → Users): a searchable list of every account where Create New User adds one, Edit opens the Edit User window to change a name or pick a role (such as admin or editor), and Remove deletes the account with everything the person added, keeping their orders, invoices and bookings.