Prerequisites¶
Before you start, confirm the four things below. They are the inputs the rest of the install assumes.
1. Host requirements¶
| Resource | Minimum | Recommended |
|---|---|---|
| OS | Linux x86_64 / arm64, or macOS for evaluation | Linux for production |
| CPU | 2 cores | 4 cores |
| RAM | 2 GB | 4 GB |
| Disk | 10 GB free | 50 GB free for log + DB growth |
| Outbound network | reachable to accounts.google.com, oauth2.googleapis.com, admin.googleapis.com, www.googleapis.com |
— |
Each customer runs an isolated ARIS instance in their own environment. The MVP install runs everything on one host.
2. Docker¶
You need Docker Engine 24.x or newer and the Compose v2 plugin (docker compose, not the legacy docker-compose).
docker --version
# Docker version 24.x.x or higher
docker compose version
# Docker Compose version v2.x.x
If you don't have Docker installed, install Docker Desktop (macOS / Windows) or Docker Engine (Linux) before proceeding.
3. Google Workspace tenant with admin access¶
You need a Google Workspace tenant — Google's term for a Workspace customer domain you own (e.g. acme.com) with at least one super-admin. This is separate from ARIS deployment isolation; ARIS itself is not a multi-tenant SaaS system. Consumer Gmail accounts are not supported.
You will need to:
- Create an OAuth 2.0 web client.
- Create a service account with domain-wide delegation authorised for two read-only directory scopes.
- Optionally, create two groups for role assignment:
aris-admin@<your-domain>andaris-auditor@<your-domain>.
Step-by-step instructions are on the next page. The whole setup happens in the Google Cloud + Workspace consoles; nothing on your host yet.
4. The ARIS source tree¶
The install runs from the repo. Clone it somewhere persistent:
The compose.yml and .env.example referenced later in this guide live at the repository root.
Next: Google Workspace setup →