Skip to main content
Theme

How-to

Create the v6 instance

The tool copies a site onto an Insites v6 instance that already exists. You create it in Insites Console, then give the tool an access token for it. Create a new, empty one: nothing is written to it until you have read and approved the plan.

Staging or production

Console offers two kinds of instance. Which one you need depends on what you are doing.

In ConsoleWhat it isUse it for
Build and testA staging instance, free. Its address ends staging-insites.io.A dry run, or trying the tool on a copy of the site.
Go liveA production instance, on a paid plan. Its address ends prod01-insites.io.The real migration. The copy, the final sync and the domain move all happen on this one instance, so create the one the site will run on.

The plan, and what it costs

A staging instance is free. A production instance is on one of four plans: Starter, Growth, Business or Pro, paid monthly or yearly. You choose the plan while you create the instance, and pay at a secure checkout once you press Create instance. Console shows the plans to choose from. Each plan includes a monthly amount of use, such as API calls, which the instance's Usage tab in Console shows against the plan. Ask your Insites contact if you are not sure which plan the site needs.

Create it

  1. Sign in to Insites Console and open Instances from the main menu.
  2. Press Create instance.
  3. Give it a name and check its address. The address is made from the name, and you can change it. Choose Build and test or Go live.
  4. When it asks how to start, choose from scratch, not a template. A template adds its own pages and records, which the migration would then have to fit around.
  5. For a production instance, choose its plan and whether to pay monthly or yearly.
  6. On Review & create, press Create instance. A production instance then goes to the secure checkout.

Every new instance comes with the Insites modules. The plan checks that their versions can take the old instance's data, and says so if one needs updating first.

Get the access token

The tool connects to the new instance with your own Console access token.

  1. In Console, open the new instance, then its CLI tab. The Access Token card is the last one on the tab.
  2. Press Get my token and copy the token. It starts iak_.
  3. In the tool, on the Destination step, paste the address of the new instance and the token.
The token needs the Developer role on the instance. Admin and Owner include it. A migration changes code, settings and files as well as records, and an Editor's token can only change records, so the tool refuses an Editor's token when you connect, before anything is planned. If you are an Editor, ask an admin of the instance to give you the Developer role, then get a new token.

More on the token, how long it lasts and what happens to it, and on the key for the old instance: Get the key for each instance.