Quickstart install

Overview

The Quickstart installation method is designed to you up and running quickly and easily by running all necessary services as Docker containers on a single Linux server. This installation method is a good choice for a lightweight and low maintenance deployment.

Interested in an on-premises deployment? Reach out to [email protected] for more info.

Requirements

• One server running Linux

  • 4 CPU cores

  • 16 GB RAM

  • 40 GB disk storage

• API token provided by Somewear Labs

Architecture

Installation Steps

Run the installation script. This will setup the Pilot CLI tool and the pilot user which will be used to run the tool. The script will also initialize the necessary configuration files.

curl -sSL https://get.somewear.app/install.sh | bash

Switch to the pilot user and initialize the configuration files.

sudo su - pilot
pilot init

The configuration initialization phase is interactive and you will need to enter a few details for the installation. You will need to input the API key that was provided to you by the Somewear Labs team, the DNS address for the installation, and credentials to create a system admin account. Below is example output from running the init command.

$ pilot init
Creating new Pilot configuration file at ~/.config/somewear/pilot.properties...
Enter a value for each property
api-key (Pilot API key provided by Somewear Labs): <REDACTED_API_TOKEN>
api-address (Web address for the api server. i.e. api.somewear.co): somewear.example.org

Configuration file created.
Creating new Somewear core configuration file at ~/.somewear/pilot/core/somewear.conf...
Enter a value for each property
WEB_APP_URL (Web address URL for the server. i.e. https://api.somewear.co): https://somewear.example.org
SOMEWEAR_IDENTITIES_TO_CREATE (Somewear system admin account (formatted as username:password)): somewear:P@ssw0rd

Configuration file created.

Run the Pilot Docker prepare command to generate the Docker compose file for the Somewear Core service.

pilot node docker-prepare

Start the services defined in the docker-compose.yml file. This will launch Postgres and Redis first, followed by the Somewear Core service.

docker compose up -d

Optionally, you can follow the container logs for the Somewear Core service to monitor the application launch.

docker logs -f somewear-core