Customer portal

This page describes what your customers can do in the portal. Use it to answer customer questions, or as a base for your own customer documentation.

In the examples, the portal runs at https://panel.example.com.

The interface#

The left menu has these sections:

GroupEntries
OverviewDashboard
ProductsCloud, Hosting, Domains, DNS
AccountBilling, Support, Settings

Billing is only shown to users with the administrator or billing role.

The Dashboard shows a short checklist (confirm the email address, complete the organization details, enable two-factor authentication, invite the team), the organization with its Account ID, the security status of the account, and links to documentation, the status page and support if the provider has set them.

Account and sign-in#

Sign up#

  1. Open https://panel.example.com/auth/sign-up.
  2. Enter your full name, email address and password. The company name is optional.
  3. Click Create account.

The password must have 10 to 128 characters. A passphrase of several words works well.

Stacklane creates an organization for you and makes you its administrator. The organization gets the company name, or your name if you left the company name empty.

Sign-up is only possible when the provider allows it. Otherwise the page shows "Registration is closed".

Confirm your email address#

After sign-up you receive an email with a confirmation link. The link is valid for 48 hours. Open it to confirm your address.

The provider can require a confirmed address before you can sign in. If the link has expired, click Resend confirmation on the sign-in page to get a new one.

Sign in#

  1. Open https://panel.example.com/auth/sign-in.
  2. Enter your email address and password.
  3. If two-factor authentication is on, enter the 6-digit code from your authenticator app, or one of your recovery codes.

You have five minutes to enter the code after the password step.

A sign-in stays valid for a number of days that the provider sets. You stay signed in on that device until then, unless you sign out.

Forgot your password#

  1. On the sign-in page, click Forgot password?.
  2. Enter your email address and click Send reset link.
  3. Open the link in the email within 60 minutes and choose a new password.

After a reset you are signed out on all devices.

Your profile#

Open Settings → My profile.

Stacklane sends you an email when your password changes and when two-factor authentication is turned on or off.

Two-factor authentication#

Two-factor authentication adds a code from an authenticator app to your password.

To turn it on:

  1. Under Two-factor authentication, click Enable 2FA.
  2. Scan the QR code with an app such as 1Password, Bitwarden, Google Authenticator or Microsoft Authenticator. You can also enter the key by hand.
  3. Enter the 6-digit code from the app and your password.
  4. Click Activate.
  5. Save the ten recovery codes that Stacklane shows. Download them or write them down.

Each recovery code works once. Stacklane shows the codes only once. Turning on two-factor authentication signs out your other sessions.

If you lose your device and your recovery codes, contact support. The provider can remove two-factor authentication from your account.

Your organization#

Open Settings → General information.

Organization details#

These details appear on your invoices. Users with the administrator or billing role can change them.

FieldNotes
Organization nameRequired.
CompanyOptional. Shown on invoices instead of the organization name.
Company registration numberOptional.
VAT numberOptional. Start with the country prefix, for example NL123456789B01. For Greece use EL.
Phone numberUse the international format, for example +31 20 123 4567.
Address, Address line 2, Postal code, City, State or provinceOptional.
CountryOptional. Decides the VAT rate.
Billing emailInvoices are sent here. Leave it empty to use your account email.

When you save a VAT number, Stacklane checks it in the VIES database of the European Commission. The page shows the result:

If you register domains, fill in the phone number, the address with the house number at the end of the first line, the postal code, the city and the country. The domain registrar needs them.

Security policy#

An administrator can turn on Require two-factor authentication for all users. Users without two-factor authentication then see a notice and must set it up before they can continue. This also applies to users you invite later.

Team members and roles#

Open Settings → All users. Only administrators can open this page.

Roles#

RoleAccess
AdministratorFull access, including users, API tokens and billing.
EngineerCan create and manage resources, but not users or billing.
BillingCan manage invoices, payment methods and company details.
ViewerRead-only access to resources.

See Clients and users for the full list of permissions.

Invite a user#

  1. Click Invite user.
  2. Enter the email address, the name and the role.
  3. Click Send invitation.

The new user receives an email with a link to choose a password. The link is valid for 72 hours.

Change a role or remove a user#

When a user's role changes or the user is removed, the API tokens that the user created are revoked.

API tokens#

Open Settings → API tokens. Only administrators can open this page. API tokens let scripts and tools use the API on behalf of the organization.

Create a token#

  1. Click Create token.
  2. Enter a name and, if you want, a description.
  3. Choose the role of the token. The token can do what a user with that role can do.
  4. Choose when the token expires: in 30, 90 or 365 days, or never.
  5. Click Create token.
  6. Copy the token. It has the form <id>$<secret>. Stacklane shows it only once.

Send the token with every request:

Authorization: APIKey <token>

The list shows when each token was last used and when it expires. Click Revoke to stop a token at once.

Some actions need a person, not a token: your own profile, two-factor authentication, creating API tokens, and opening or answering support requests. See API.

Audit log#

Open Settings → Audit log. Only administrators can open this page. It shows the changes in the organization, by people and API tokens, with the time, the actor, the source IP address and the trace ID. Filter by category (authentication, users, API tokens, organization) and by period.

Cloud#

Open Cloud in the left menu. If the provider has no active region, the page shows "Cloud is not available yet".

At the top of the cloud menu you choose the Project and the Region. The lists of instances and SSH keys show the selected project and region.

Projects#

Projects group instances and SSH keys. Every organization has a project called Default. Click New project to add another one.

The default project cannot be deleted. A project with instances cannot be deleted. Renaming and deleting projects is possible through the API.

SSH keys#

Open Cloud → SSH keys. SSH keys belong to a project.

  1. Click Add SSH key.
  2. Enter a name.
  3. Paste the contents of your public key file, for example ~/.ssh/id_ed25519.pub.
  4. Save the key.

Supported key types: ssh-ed25519, ssh-rsa, ecdsa-sha2-nistp256, ecdsa-sha2-nistp384, ecdsa-sha2-nistp521, sk-ssh-ed25519@openssh.com and sk-ecdsa-sha2-nistp256@openssh.com. A key can be added to a project only once.

When you remove a key, it is no longer offered for new instances. Existing instances keep the key.

Create an instance#

  1. Open Cloud → Virtual instances and click Create instance.
  2. Check the region. To use another region, change it in the menu on the left.
  3. Choose the Operating system.
  4. Choose the Configuration (flavor). Each flavor shows vCPUs, memory, disk and price.
  5. Under Access, select one or more SSH keys, or enter a password, or both. The password is for the default user of the image and needs at least 12 characters.
  6. Enter the Instance name, up to 63 characters.
  7. Check the Summary with the monthly price, the hourly price and the price including VAT.
  8. Click Create instance.

Stacklane builds the host name of the instance from its name: lowercase, with other characters replaced by hyphens. For example, Web Server #1 becomes web-server-1.

The page shows how many instances you use of your quota. The provider sets limits for the number of instances, vCPUs and memory per organization.

The instance starts with the status Creating. When it is ready, the status becomes Running and the page shows the IP address. If creation fails, the status is Error and the page shows the reason. Delete the instance and try again, or contact support.

Users with the administrator or engineer role can create and change instances. Other roles can view them.

Instance status#

StatusMeaning
CreatingThe instance is being built.
RunningThe instance is on.
StoppedThe instance is off. It is still billed.
ErrorThe last action failed.
DeletingThe instance is being deleted.

Power actions#

On the instance page:

ButtonEffect
StartTurns the instance on.
RebootRestarts the instance.
Shut downAsks the operating system to shut down cleanly.
Power offTurns the instance off at once, like pulling the plug.

Only one action can run at a time on an instance. While an action runs, other actions return "Another operation is still running on this instance".

There is no browser console. Connect with SSH to the IP address of the instance.

Monitoring#

The Monitoring tab shows graphs of CPU usage, network traffic (inbound and outbound) and disk throughput (read and write). Choose the last hour, day, week or month.

Networking and firewall#

The Networking tab shows the IP address, prefix and gateway, the firewall and the DDoS protection.

The firewall runs on the hypervisor, before traffic reaches the instance.

  1. Click Add rule.
  2. Choose the direction (Inbound or Outbound) and the action (Allow or Block).
  3. Choose the protocol: Any, TCP, UDP or ICMP.
  4. For TCP and UDP, enter a port, for example 22, or a range, for example 8000:8100. Leave it empty for all ports.
  5. Enter a source address or network, for example 198.51.100.0/24. Leave it empty for Anywhere.
  6. Add a comment if you want.
  7. Click Apply rules.

Stacklane turns on the firewall of the instance when you apply rules. From then on, inbound traffic that matches no rule is blocked, and outbound traffic is allowed unless a rule blocks it. If you apply an empty list, all inbound traffic is blocked. You can add up to 50 rules. Stacklane applies the rules to the hypervisor in the order of the list.

DDoS protection#

When the provider has connected a DDoS detector, the Networking tab shows Protected. During an attack it shows "Under attack, filtering active". The list shows the last 20 attacks with the start time, attack type, peak traffic, mitigation and status.

The provider can also send an email to the administrators of the organization when an attack starts.

Snapshots#

The Snapshots and volumes tab lets you save the state of the instance and restore it later.

  1. Enter a name, for example before-upgrade. The name has 2 to 40 characters, starts with a letter and uses only letters, digits, - and _.
  2. Click Take snapshot.

Each snapshot name can be used once per instance. The provider sets the maximum number of snapshots per instance. When you reach it, delete a snapshot before you take a new one.

Volumes#

Volumes are extra disks, billed per GB per month.

  1. On the Snapshots and volumes tab, click Add volume.
  2. Enter a name (same rules as for snapshots) and a size from 1 to 4,096 GB.
  3. Confirm.

The volume appears as a new, empty disk in the instance. Format and mount it in the operating system before you use it. When you delete a volume, all data on it is deleted permanently. The provider sets the maximum number of volumes per instance.

Delete an instance#

On the instance page, click Delete and confirm. The instance and its disk are deleted permanently. This cannot be undone. The IP address goes back to the pool of the provider.

Hosting#

Open Hosting in the left menu. It lists your web hosting accounts and game servers.

Order hosting#

  1. Click Order hosting.
  2. Choose a plan under Web hosting or Game servers. Each plan shows its features and monthly price.
  3. Enter a Name to recognise the service, for example the name of your website.
  4. For web hosting, enter the main Domain of the account. Point its DNS to the provider after ordering.
  5. Click Order now.

The service starts with the status Setting up. When the account is ready, the status becomes Active. Hosting is billed per hour, up to the monthly price.

Users with the administrator or engineer role can order and cancel hosting.

Use the service#

On the service page you find:

Service status#

StatusMeaning
Setting upThe account is being created.
ActiveThe account works.
SuspendedThe account is suspended, for example because of an unpaid invoice. Pay your open invoices or contact support.
ErrorSetting up failed. Cancel the service or contact support.
CancellingThe account is being deleted.

Cancel a service#

Click Cancel service and confirm. The account and all its files, databases and mailboxes are deleted permanently. A suspended service cannot be cancelled. Contact support instead.

Game servers#

If your provider manages game servers through Stacklane, the page of a game server has these tabs:

TabWhat you can do
ConsoleSee the live console and send commands. Start, restart, stop or kill the server. See CPU, memory, disk and network use, the address and the uptime.
MinecraftChange the server type (Paper, Purpur, Fabric or Vanilla) and version, install plugins, mods and data packs from Modrinth, install a Fabric modpack, and choose a free address. Only shown for Minecraft servers.
FilesBrowse folders, edit text files (press Ctrl+S to save), upload files by clicking Upload or by dragging them onto the list, download files, rename, duplicate, delete, compress and extract. Download from URL lets the server fetch a file from a public address.
BackupsCreate, download, restore, lock and delete backups. A locked backup cannot be deleted.
DatabasesCreate MySQL databases, see the connection details, set a new password or delete a database.
SchedulesRun commands, power actions and backups at set times. Each schedule has one or more tasks with an optional delay.
NetworkAdd extra ports, set the primary port and add notes.
StartupSee the startup command, change the software version (Docker image) and edit the startup variables. Restart the server after a change.
ActivitySee the recent changes to the server.
SettingsRename the server, see the SFTP details, see the plan limits, reinstall the server or cancel the service.

Minecraft EULA: a new Minecraft server only starts after you accept the Minecraft EULA. When the console shows this, click I accept, start the server.

Changing the version: your worlds are kept. Going back to an older Minecraft version can break a world, so make a backup first.

Modpacks: with Start fresh, the current mods and config folders are removed and your worlds are kept as a copy named world-before-modpack-<date>. The modpack then starts with a new world.

Users with the viewer role can see the server status and statistics, the file list, backups, schedules, ports, startup settings and activity. They cannot open the console, open or download files, or change anything.

Domains#

Open Domains in the left menu.

Search and register#

  1. Type a name in the search field, for example bakery or bakery.com, and click Search.
  2. Stacklane shows up to eight extensions with the registration and renewal price. Each result is Available, Taken or On request.
  3. Click Register next to the domain you want.
  4. Choose the Registration period, from 1 to 10 years.
  5. Keep the default nameservers, or enter two to six nameservers of your own.
  6. Click Register domain.

The price is taken from your credit balance at once. If your balance is too low, the portal asks you to add credit first. If the registration fails, the amount goes back to your credit automatically.

Only users with the administrator or billing role can register domains.

Domain status#

StatusMeaning
RegisteringThe registration is being processed. With some providers, the team processes it by hand.
ActiveThe domain is registered.
ExpiredThe domain has expired. Contact support to restore it.
FailedThe registration failed. The amount was refunded to your credit.

Nameservers and auto-renew#

On the domain page:

Users with the administrator or engineer role can change these settings.

DNS zones and records#

Open DNS in the left menu. This section is available when the provider offers DNS hosting.

Add a zone#

  1. Click Add zone.
  2. Enter the domain name, for example example.com.
  3. Save.

The zone page shows the nameservers of the provider. Point your domain to these nameservers at your registrar.

The provider sets the maximum number of zones per organization. A domain that another organization registered through the portal cannot be added as a zone.

Records#

Click Add record, or edit an existing record.

FieldNotes
NameUse @ for the zone itself, or a label like www. Labels can contain letters, digits, -, _ and *.
TypeA, AAAA, CNAME, MX, TXT, NS, SRV or CAA.
TTLSeconds that resolvers may cache the record, from 60 to 604,800. Default: 3,600.
ValuesOne value per line, up to 50.

A record is a set of values for one name and one type. Saving replaces all values of that name and type.

TypeValue formatExample
AOne IPv4 address203.0.113.10
AAAAOne IPv6 address2001:db8::10
CNAMEOne target host nameshop.example.net
MXPriority and mail server10 mx1.example.net
TXTTextv=spf1 include:example.net -all
NSNameserver host name, for a subdomain delegationns1.example.net
SRVPriority, weight, port and target10 5 5060 sip.example.net
CAAFlags, tag and value. The tag is issue, issuewild or iodef.0 issue letsencrypt.org

Rules:

Deleting a zone deletes all its records. The domain stops resolving if it still points to the provider's nameservers.

Users with the administrator or engineer role can change zones and records.

Billing#

Open Billing in the left menu. Only users with the administrator or billing role can see it.

Overview#

The overview shows:

Charges are calculated per hour. A month counts as 730 hours, and a resource never costs more than its monthly price in one month.

Add credit#

  1. Click Add credit.
  2. Enter the amount. The page shows the minimum.
  3. Choose a payment method.
  4. Click Continue and complete the payment at the payment provider.

After payment you return to a page that shows the result. While the provider has not confirmed the payment yet, the page shows "Waiting for confirmation" and updates itself.

Credit is used for new invoices and for domain registrations and renewals.

Invoices#

Open Billing → Invoices. Invoices are issued at the start of every month for the previous month. If your credit covers the amount, the invoice is paid at once.

An invoice is Open, Overdue, Paid or Void. Click an invoice to see the lines, the VAT and the amount due. Click Download PDF to print or save it.

To pay an open invoice, click Pay invoice and choose a payment method.

Payment methods#

The provider chooses which methods are available:

MethodNotes
iDEAL, Bancontact, card and moreThrough Mollie.
Credit or debit cardThrough Stripe.
PayPalThrough PayPal.
Bank transferTransfer the amount to the account shown, with the reference exactly as shown. The provider processes bank transfers by hand.

Transactions#

Open Billing → Transactions to see every change to your credit balance: top-ups, credit applied to invoices, domain charges, refunds and adjustments by the provider.

Unpaid invoices#

When an invoice is past its due date, you receive a reminder. If it stays unpaid for longer, the provider can suspend your hosting services and power off your instances. Until you pay, you cannot create or start instances, add volumes, order hosting or register domains. After payment, your hosting services are restored automatically. Start your instances again in the portal.

Support#

Open Support in the left menu. Every user can open and answer support requests.

Open a request#

  1. Click New request.
  2. Enter a Subject, up to 150 characters.
  3. Choose a Category: General, Technical, Billing, Sales or Abuse.
  4. Choose a Priority: Low, Normal, High or Urgent.
  5. Write your Message. Include instance names, domains or invoice numbers if they matter.
  6. Click Send.

Follow a request#

StatusMeaning
Waiting for supportThe support team has not replied to your last message yet.
AnsweredThe support team replied.
ClosedThe request is done.

You receive an email when the support team replies to a request you opened. Open the request to read and answer the message.

Click Close request when your question is solved. If you reply to a closed request, it opens again.

Use the filter to see Open requests or All requests.