Skip to content

Create and manage your installations

You select New installation, call it Production, leave the size as offered and select Create installation. The new card reads Provisioning… for a couple of minutes, then Active. Select its address and your installation opens in a new tab.

Each card on the dashboard is one complete installation of Player One, with its own address, agents, files and memory. This page covers making one, what the card tells you, and what the ⋯ menu on it does. What an installation costs is on Plans, balance and billing. Who may open it is on Organisations, people and teams.

What a card shows

A card shows the installation's name, its state, its size, a release name and its address. One line along the bottom shows the single thing that needs you, if anything does. Above the cards one line counts them: how many in total, how many running, how many starting or updating, how many stopped, and how many need attention. An update waiting or a custom domain not yet verified counts as needing attention.

The state is one of these words.

State What it means
Active Running.
Provisioning…, Starting…, Restarting…, Upgrading…, Stopping…, Deleting… Something is in progress. The card shows a percentage when it knows one, and the bottom line says roughly how long: a minute or so to start, a few minutes to update.
Waiting for payment The room for a new installation is being paid for. It starts once the payment goes through.
Stopped, Suspended Switched off. Hovering the word says why: "Paused by you" when you stopped it, "Suspended for payment" when a payment is overdue, or "Paused by support".
Degraded, Down Running badly or not at all. Hovering says "Partially working", "Something is wrong" or "Stopped unexpectedly".

A stopped installation, and one that is still starting, answers at its address with a waiting page rather than an error.

Create an installation

You need a plan or a running free trial first. With neither, New installation takes whoever manages billing to the plan chooser. For everyone else the panel says to Choose a plan first, and that whoever manages billing in the organisation chooses it. Plans, balance and billing covers both.

  1. Select New installation at the top right. If your organisation has more than one place to run, a menu asks Where should it run?: Shared infrastructure, which runs on Player One cloud, or one of your dedicated clusters. A cluster that cannot take another stays in the list, marked unavailable. The panel shows the place you chose, with Change.
  2. If you can create in more than one project, choose the Project.
  3. Under Data, leave Empty, or choose From archive to start from an earlier export of an installation, or from a .tar.gz file you upload. The new installation gets its own address. Bots and integrations set up in the archive run in the new installation too, so stop the old one if both should not answer.
  4. Type the Installation name.
  5. On shared infrastructure, choose its Memory and Disk. A line above says how much of your plan you have used, such as "1 of 3 installations · 4 of 6 GB used", and that you can size it as you like within the plan. Inside the plan there is nothing to pay. Beyond it the panel shows the extra charge for the rest of the period and takes the payment there.
  6. With a Team plan, Who can use it lists you as Administer. If you manage members, you can add people or teams here too, each with Log in or Administer.
  7. Under Advanced, a Help URL replaces the default Player One help page for this installation. Leave it blank to keep the default.
  8. Select Create installation. On a free trial the button reads Start free trial, and where something is due it reads Pay $X and create.

A note at the top of the page says the installation is being created and takes a couple of minutes. If it needs a payment, closing the panel before the payment goes through gives the purchase up, and nothing is charged. If the payment is still processing when the panel closes, the note says the installation is waiting for its payment and starts once it goes through.

An installation on one of your dedicated clusters uses none of your plan's room, so it has no size to choose.

Open it

Select the address on the card, or Open installation in the ⋯ menu. You sign in to the installation with your Player One account, so there is no separate password to set. Signing in and keeping your account safe explains how that works. Your first hour picks up from there.

The ⋯ menu

Anyone who may open an installation sees Open installation and Access. Access lists who can use it and why. The rest is for people with Administer on it: every Owner, whoever created it, and anyone who has been given that right.

Item What it does
Update Starts the update, when one is ready. See below.
Custom domain Puts the installation on your own address. See below.
Resize Changes its memory and disk.
Exports Makes and downloads an archive of all its data.
Edit Renames it and changes its help link.
Move to project Appears when your organisation has several projects.
Stop and Start Stops it, or starts it again.
Delete Removes it for good.

Resize

Select Resize, then choose a new Memory and Disk. The installation restarts at the new size. A disk only grows.

The panel says what the change does to your plan before you confirm. A change that fits inside your plan reads Within your plan, no charge. One that goes beyond it reads Beyond your plan: +$X / month, shows what is charged now for the rest of the period, and takes the payment in the panel. A smaller size reads Less beyond your plan and credits the difference to your balance straight away. Closing the panel while a payment is open cancels the resize, and nothing is charged.

Stop and start

Stop switches the installation off and the card says Stopped. Start switches it on again, and the bottom line of the card has a Start link too. Stopping does not lower your plan's price or free any room in it. Delete the installation to do that.

Exports

Exports lists the archives made of this installation, with the date, the size, how long each is kept and a Download button. Export data makes another. The installation stops while the archive is made, so the data in it is consistent, and starts again when the archive is saved. Nothing is changed or overwritten. The panel says how long an archive is kept, so download it to keep it longer. An export is also what you pick under From archive to make a copy of the installation.

This is the whole installation. To take only some projects or items, use Admin > Backups (/admin/backups) inside the installation: Back up and move your data.

Edit

Edit changes the Installation name and the Help URL. Saving a new help link redeploys the installation so the link takes effect.

Move to project

With several projects, Move to project sends the installation to another. Its address and data stay as they are, and access given on a project follows the project it is in. Projects come with a Team plan: Organisations, people and teams.

Delete

Delete asks you to type the installation's name, and it cannot be undone. It removes the installation and everything in it, so export what you want to keep first. The dialog also says what happens to the money. If the installation used room beyond your plan, that part is credited to your balance. If it was inside your plan, nothing is credited.

Put it on your own domain

Say you want app.mycompany.com instead of the address Player One gave it. A custom domain needs a plan, not the free trial.

  1. Select Custom domain in the ⋯ menu.
  2. Type the domain, such as app.mycompany.com, and select Set custom domain.
  3. Add the record the dialog shows wherever your DNS is managed. It is a CNAME, and the dialog gives the name and the target.
  4. Select Verify DNS. If the record has not spread yet, the dialog says so. DNS changes can take up to 48 hours.
  5. When it passes, the dialog says Custom domain is active with TLS and the card shows Verified beside the address.

Until it passes, the card shows DNS pending beside the address, and its bottom line says DNS not verified with a Set up DNS link back to the dialog. Remove in the dialog, or Remove custom domain once it is active, puts the installation back on its own address.

Updates

When a new release is ready for your installation, the bottom line of its card shows the release's name, a date such as "auto on Nov 12" and a red Update now button. Update in the ⋯ menu does the same.

Updates reach installations in stages, so yours may be offered a little after someone else's. You can update as soon as the card offers it, or wait. The date is a deadline: after it, Player One updates the installation for you. Hovering the date says so. A stopped installation is updated too, and stays stopped. People who may open an installation but not administer it see Auto-updates on the date, without a button.

Select Update now and a dialog asks you to confirm. It warns you that:

  • the installation can be unavailable for up to ten minutes;
  • it restarts, so any service that is not set to start by itself stops;
  • any work in progress inside it stops.

Pick a quiet moment, then select Update. When it is running again, your assistant walks you through what changed: Your installation describes the Required update banner and the walkthrough.

On an installation hosted by Player One you can also start the update from inside it. When a new release is ready, a one-line notice appears above the greeting on New chat (/). It reads "Player One" and the version, "is ready", says that upgrading restarts the instance briefly, and gives the date it upgrades on its own if there is one. Upgrade now starts the update, and the notice then says the instance will restart in a moment and reconnect on its own. The ✕ hides the notice until the next version. Pressing Upgrade now needs Administer on the installation, as Update now on the card does.

Dedicated clusters

If your organisation has infrastructure of its own, a Clusters row appears in the sidebar for people who may create installations. Each cluster shows its name, its address, its state, how many of its nodes are ready, how many installations are on it, its processor and memory use, and how many more installations it has room for. On the dashboard, installations on a cluster sit under that cluster's heading, with Usage for its processor and memory.

Dedicated clusters come with an Enterprise agreement. The Enterprise tab on the plan chooser has a Book a call button and an email address for that.