Install a new site

This page takes you from nothing to a signed-in new site. If the site is an existing v4 site, go to Upgrade from v4.

Before you startCopy Anchor Link

• Docker, Docker Compose and curl (Requirements)
• The registry user name and password you got from aWhere
• The web address users will open, such as https://app.example.com

InstallCopy Anchor Link

1. Install the aWhere CLI.

   Copy Text

   curl -fsSL https://docs.awhere.online/install.sh | sh -s -- 5.0.0

2. Create the site. The command asks you questions one at a time, makes every password and secret the system needs, runs Preflight, and then deploys.

   Copy Text

   awhere setup

   From a script, pass the answers as flags instead, such as awhere setup --yes --url https://app.example.com.

3. Check that every container is ready.

   Copy Text

   awhere status

   When all are ready, you see this line.

   Copy Text

   ✓ all N components are ready

4. Open https://app.example.com/. You see the platform's front page (the Portal), which for now shows only the name and a Sign in button because Public access is off.

5. Open https://app.example.com/configuration/ and sign in with the administrator account you set at install time.

Then open the System page in Configuration. Every node should be Ready and every Migration Done. If not, see Troubleshooting.

Make the first administratorCopy Anchor Link

A new site has no users and no default password. So before it installs anything, awhere setup asks for the administrator's user name (default admin), then asks you to set a password of at least 8 characters, typed twice.

If you press Enter without typing a password, the system makes one and shows it only once, when the install ends. Write it down at once, because the system saves this password nowhere.

From a script with --yes, pass the password in the variable AWHERE_ADMIN_PASSWORD, and put the user name in place of <username>.

read -rs AWHERE_ADMIN_PASSWORD && export AWHERE_ADMIN_PASSWORD
awhere setup --yes --url https://app.example.com --admin-username <username>

If the site already has an administrator, such as a site moved from v4, this step changes nothing. If setup fails to make the administrator, the site still works as usual. Run awhere admin later (from a script, awhere admin --username <username> --yes).

After you sign in, change the password at Manage your account (Change your password). Add other people at Users (Users).

If you use Apple ContainerCopy Anchor Link

If you use Docker, skip this part.

The steps are the same as for Docker, with these differences.

• Run container system start before awhere setup.
• There is no proxy included. Set one up yourself (If you use your own proxy).
• Install the watchdog, as described below.

Make the platform start again after a rebootCopy Anchor Link

Apple Container has no restart policy, so install the watchdog once. The watchdog starts again any container that has stopped.

awhere watchdog install

Remove the platformCopy Anchor Link

The command awhere teardown deletes all the containers, volumes and files of this site. To keep the data and secrets, use awhere teardown --keep-data.