Administration

The back office is the part of Stacklane where your staff run the platform. Here you connect Proxmox clusters, hosting panels, the domain registrar, PowerDNS and payment providers. You also set prices, handle invoices and answer support requests.

What the back office is#

The back office is not a separate application. It is a section of the same portal that your customers use. A staff member signs in with a normal account. When that account has a platform staff role, the portal shows an extra Administration entry.

All back-office actions use the API under /api/admin. See API for the endpoints.

Stacklane writes an audit record for the changes made in the back office. The record belongs to the organization of the staff member who made the change. See Clients and users.

Platform staff roles#

Every user belongs to one organization and has a role inside that organization (administrator, engineer, billing or viewer). A user can also have a platform staff role. The staff role gives access to the back office. It does not change what the user can do inside their own organization.

There are four staff roles:

Staff roleIntended for
ownerThe person who installed Stacklane. stacklane setup creates the first owner.
adminStaff who configure the platform.
billingStaff who handle invoices and customer credit.
supportStaff who answer support requests and handle customer services.

owner and admin have the same permissions in the back office. The only difference is that the command line does not let you remove the staff role from the last owner.

What each role may do#

Taskowneradminbillingsupport
Platform settings (brand, sign-up)YesYesNoNo
Regions, flavors, images, limitsYesYesNoNo
Network and DDoS settings, signing secretYesYesNoNo
View the list of DDoS attacksYesYesNoYes
Panel servers and hosting plansYesYesNoNo
List hosting services, suspend, unsuspend, terminateYesYesNoYes
Registrar settings and extension pricesYesYesNoNo
List all domains, mark a domain as registeredYesYesNoYes
DNS hosting settingsYesYesNoNo
Billing settings and payment providersYesYesNoNo
View invoices, mark as paid, voidYesYesYesNo
Adjust a customer's credit balanceYesYesYesNo
Run billing nowYesYesNoNo
Helpdesk: read, reply, add notes, assignYesYesYesYes

The API checks these permissions on every request. A request without the right role returns 403 with the error code forbidden.

Note: every staff role sees the Administration entry in the menu. Inside the back office, each user only sees the pages that their role may use. Users with the support role start in the Helpdesk. Some actions that the table allows for them, such as suspending a hosting service, are only available through the API.

Give someone a staff role#

You assign staff roles on the command line of the server. There is no screen for it in the portal.

  1. Make sure the person has an account. They can sign up in the portal, or you can create the account with stacklane user create.

  2. Run the command as the service user:

    sudo -u stacklane stacklane user staff --email agent@example.com --role support
    
  3. Use --role none to remove the staff role again.

To create a new account that has a staff role from the start:

sudo -u stacklane stacklane user create --email ops@example.com --name "Operations" --staff-role admin

See Command line for all options.

Staff accounts can sign in without a confirmed email address, even when you require confirmed addresses for customers.

Open the back office#

  1. Sign in to the portal, for example at https://panel.example.com, with an account that has a staff role.
  2. In the left menu, under Platform, click Administration.

You can also go to https://panel.example.com/admin directly. Owners and admins start on the Regions page. Billing staff start on the Invoices page.

The back-office menu has these groups:

GroupPages
SupportHelpdesk
CloudRegions, Flavors, Images, Limits, Network and DDoS
HostingPanel servers, Hosting plans, Domains, DNS hosting
BillingInvoices, Billing settings
PlatformPlatform settings

Each staff member only sees the pages that their role allows.

Set up a new platform#

Some settings depend on others. For example, every price must use the billing currency. We suggest this order:

  1. Branding and access: set the product name, colors, links and sign-up rules.
  2. Billing: set your company details, the currency, VAT and at least one payment method.
  3. Cloud: add a region, images, templates, flavors and an IPv4 pool.
  4. Hosting: add panel servers and hosting plans.
  5. Domains and DNS: connect the registrar, set extension prices and connect PowerDNS.
  6. Network protection: connect your DDoS detector.
  7. Set a support email address so your team receives new support requests. See Support.

Pages in this section#

PageContents
Branding and accessProduct name, accent color, links, support email, sign-up and default language and time zone.
BillingCompany and VAT settings, EU VAT rules, credit, invoices, metering, payment providers, reminders and suspension.
CloudProxmox regions, templates, images, flavors, IPv4 pools, limits, and what to do when a task fails.
HostingcPanel/WHM, DirectAdmin and Pterodactyl servers and plans, provisioning and suspension.
Domains and DNSOpenprovider or manual registrar, extension prices, renewals, PowerDNS and nameservers.
Network protectionThe DDoS webhook, request signing, FastNetMon, customer notifications and panel rate limits.
SupportThe helpdesk, ticket statuses, replies and internal notes.
Clients and usersOrganizations, users, roles, staff accounts and the audit log.