Skip to main content

Getting Started

Installation​

  1. Install the latest o2id binary for your platform (Linux and macOS, amd64 and arm64) with:
curl -fsSL https://o2id.dev/install.sh | sh

This downloads the latest release from GitHub releases. o2id is usually run from a project directory alongside its own config and data, so the script installs it into the current directory by default, prompting you to confirm or pick a different location (set O2ID_DIR to skip the prompt).

Alternatively, download the binary for your platform manually from the releases page.

  1. Verify the install:
./o2id version

Start the server​

./o2id serve --addr :8080

If you installed o2id to a directory on your PATH instead, drop the ./.

The server starts on port 8080 by default. Omit --addr to use the default.

Setting up super admin​

The very first time o2id serve runs against an empty database, it prompts for an email and password for the super admin user, creates that user, and assigns them a seeded Super Admin role with the * scope.

No users found — setting up the super admin account.
Email: admin@example.com
Password:
Created super admin admin@example.com

See Managing Roles for how to create more limited roles, and the API Reference for what each scope grants.

Verify the service is running​

Verify that the service is running by invoking the /health endpoint:

curl http://localhost:8080/health

You should see the following response:

{"status":"ok"}

Next steps​