Back to Learn

Aptabit Platformv3.7

Get started

Quickstart

From the installation key to the first sign-in, on a Linux server.

On this page

This guide installs the Aptabit Platform on a single Linux server with Docker, from the installation key to the first sign-in. For a machine without access to Aptabit Manager, see Isolated installation. For external databases and storage, see Operations.

Before you begin

  • A Linux x86_64 or arm64 server with at least 4 GiB of RAM and 10 GiB of free disk (recommended: 8 GiB and 50 GiB). See Requirements and sizing.
  • Docker Engine with Compose v2, usable by your user.
  • Your license's install command, shown in Aptabit Manager, with the installation key (aptk_...). The key can be reused up to the license's installation limit.

Check Docker:

Shell
docker --version
docker compose version
docker ps

If docker ps fails with a permission error, fix Docker access before you continue. The CLI does not need root, but it depends on that access.

1. Install the CLI

Run the command shown in Aptabit Manager. It looks like this:

Shell
curl -fsSL 'https://manager.aptabit.com/v1/installations/install.sh' \
  | env APTABIT_MANAGER_URL='https://manager.aptabit.com' APTABIT_INSTALL_KEY='<installation-key>' sh

The script downloads the CLI for the machine's operating system and architecture, checks it against the release manifest signed by Aptabit, and stores the Aptabit Manager settings in ~/.aptabit/bootstrap.env. On a terminal, it offers to run aptabit install next.

Confirm the version:

Shell
aptabit --version

The CLI speaks Brazilian Portuguese and English. It asks for the language on the first run; --lang pt-BR or --lang en changes the choice.

2. Check the machine

Shell
aptabit check

The report covers the operating system, memory and disk, Docker and Compose, GPUs and NPUs, reachability of Aptabit Manager, certificate trust, clock, and proxy. A blocking finding stops the installation before any file is written (exit code 3). aptabit install runs this check automatically.

3. Install the platform

Shell
aptabit install

The installer asks for the installation location, the HTTP port, and the organization name, with defaults for a single server. On a new machine, it:

  1. Creates the installation's identity: an Ed25519 key pair generated on the machine itself.
  2. Registers the server with Aptabit Manager using the installation key. When the license requires approval, it waits up to 20 minutes for Aptabit to approve; running aptabit install again resumes where it stopped.
  3. Generates the installation files and starts the stack.

install is safe to re-run. With an existing installation, it updates in place and keeps the data. Removing an installation takes the advanced aptabit uninstall command, which asks you to type the installation path to confirm.

Each installation lives in its own folder:

Text
<installation>/
  config.yaml          # source of truth for the installation
  docker-compose.yml   # generated from config.yaml
  identity/            # installation identity (local private key)

4. Complete the first sign-in

When it finishes, aptabit install points to the /setup page. There, create the organization and the owner account. With an installation key there is no token to enter: the license is already bound to the installation.

The same can be done from the terminal, with the same checks as the page:

Shell
aptabit setup

For automation, with no questions:

Shell
aptabit setup \
  --config /opt/aptabit/production/config.yaml \
  --tenant-name "My Organization" \
  --email owner@example.com \
  --display-name "Owner" \
  --password-stdin < owner-password.txt

Pass the password through --password-stdin or the APTABIT_SETUP_PASSWORD variable. A password on the command line stays in the shell history and the process list. The password must have at least 12 characters.

The account created in setup is the root account: it always signs in with e-mail and password, never takes part in SSO, and is the way back in if the identity provider fails. See Users, roles, and access.

To see whether setup is still pending:

Shell
curl http://localhost:8080/api/v1/setup

5. Verify and sign in

Shell
aptabit status
aptabit license

Open http://<server>:8080 in the browser and sign in with the owner account. The platform's proxy serves HTTP; for HTTPS, publish the platform behind your organization's load balancer or reverse proxy.

Next steps

  1. In Settings > Models, connect an external provider or deploy a local model and enable it in a workspace. See Models, runtimes, and accelerators.
  2. In Storage, create a knowledge context and upload the first documents. See Storage.
  3. In Settings > Users & access, add people, grant modules, and, if you wish, configure SSO.
  4. In Flows, start from one of the 30 flow templates. See Flows and schedules.

Documentationv3.7