First-time setup

Overview

A new Virtool instance has no users. The first person to open it creates the first administrator. Do this step immediately after you install Virtool.

When you see the setup screen

Open the address of your Virtool instance in a browser. If the instance has no users, Virtool shows the Set up Virtool screen.

After the first user exists, the setup screen goes away. If a person opens the setup address after that, Virtool shows the sign-in screen.

Any person who can open the instance before you can create the first administrator. Create the first administrator before you give other people the address.

Create the first administrator

  1. Type a username in Username.
  2. Type your email address in Email.
  3. Type a password in Password.
  4. Type the same password again in Confirm password.
  5. Click Create administrator.

Rules for the fields

All of the fields are required.

  • Username: 3 to 30 characters. Use only letters, numbers, _, and .. You can type it in any case. Virtool keeps it in lowercase. You cannot use the username virtool. You sign in with this username.
  • Email: a valid email address.
  • Password: at least 8 characters. This is the default minimum password length.
  • Confirm password: the same value as Password.

If two people use the setup screen at the same time, Virtool creates only one administrator. The other person sees the sign-in screen with the message Virtool is already set up. Sign in to continue.

After you create the administrator

Virtool signs you in and opens the app. Later, sign in with your username and password. See Sign in.

You do not need email delivery to finish setup. On a new instance, email delivery is off, so Virtool does not send email. If email delivery is set up, Virtool sends a link to verify your email address. It then shows Check your email. Click Continue to Virtool to open the app.

What the first administrator can do

The first user is a full administrator. A full administrator has all permissions, and all rights on all samples and references. It is the only role that can give administrator roles to other users. See Administrator roles.

Next steps

  1. Set the encryption key and the other environment variables. See Configuration.
  2. Set up email delivery, the NCBI API key, the two-factor authentication policy, the maximum upload size, and the other instance settings. See Administration.
  3. Verify your email address. Virtool saves the address from setup as not verified, and it can’t send a verification link until email delivery is set up. See Change email.
  4. Create groups and invite users. See Users.
  5. Install the HMMs. See HMMs.
  6. Create a reference. See References.
  7. Create subtractions. See Subtractions.

Give a second user the Full administrator role. If you are the only administrator and you forget your password before your address is verified, no one in Virtool can create a password reset link for you.