Getting Started
Relevant source files
The following files were used as context for generating this wiki page:
Probo is an open-source compliance platform designed to help startups achieve SOC-2 compliance efficiently. It provides features like automated risk assessment, AI-powered policy generation, and evidence collection. This guide covers how to set up Probo for local development and how to deploy it to a Kubernetes cluster.
The platform is built with a Go backend serving a GraphQL API and a React frontend. It relies on PostgreSQL for data storage and Docker for containerization. For more details on the architecture, see the Tech Stack section in the main README.md.
Sources: README.md:12-15, README.md:90-101
Local Development Setup
This section outlines the steps to run the Probo application on your local machine for development purposes.
Prerequisites
Before you begin, ensure you have the following tools installed on your system.
| Tool | Required Version | Description |
|---|---|---|
| Go | 1.21+ | For building and running the backend API. |
| Node.js | 22+ | For frontend dependencies and development server. |
| Docker | - | To run infrastructure services like databases. |
| mkcert | - | To test custom domains feature locally. |
Sources: README.md:31-35, CONTRIBUTING.md:34-37
Installation and Startup
Follow these steps to get the development environment up and running. The process involves installing dependencies, starting infrastructure services with Docker, building the application, and finally, running the backend and frontend servers.
The following diagram illustrates the startup sequence for local development.
Sources: CONTRIBUTING.md:41-67
1. Clone and Install Dependencies
First, clone the repository and install the necessary Go and Node.js dependencies.
# 1. Clone the repository
git clone https://github.com/getprobo/probo.git
cd probo
# 2. Install Go dependencies
go mod download
# 3. Install Node.js dependencies
npm ci
Sources: CONTRIBUTING.md:43-55
2. Start Infrastructure Services
Probo uses Docker to manage its infrastructure services for local development. The make stack-up command starts all required containers.
make stack-up
This command initiates several services, including the database and object storage, as defined in the project's Docker Compose files.
Sources: CONTRIBUTING.md:59-61
3. Build and Run the Application
After the infrastructure is running, build the application binaries and start the development servers.
# 1. Build the project
make build
# 2. In one terminal, start the API server
bin/probod -cfg-file cfg/dev.yaml
# 3. In another terminal, start the frontend
npm -w @probo/console run dev
The application will be available at http://localhost:3000, with the API server running on http://localhost:8080.
Sources: README.md:48-55, CONTRIBUTING.md:57-67
Kubernetes Deployment (Helm)
Probo can be deployed to a Kubernetes cluster using the provided Helm chart. This method is recommended for production environments and requires external managed services for PostgreSQL and S3-compatible storage.
Sources: contrib/helm/README.md:6-12
Prerequisites
- Kubernetes 1.23+
- Helm 3.8+
- An external PostgreSQL database
- An S3 or S3-compatible object storage bucket
Sources: contrib/helm/charts/probo/README.md:5-9
Deployment Architecture
The Helm chart deploys the Probo application and an optional headless Chrome instance for PDF generation. It relies on external services for data persistence.
This diagram shows the high-level architecture of a Kubernetes deployment.
Sources: contrib/helm/README.md:65-80
Installation Steps
-
Generate Secrets: The application requires several secret keys for encryption and authentication. Generate them using
openssl.export ENCRYPTION_KEY=$(openssl rand -base64 32) export COOKIE_SECRET=$(openssl rand -base64 32) export PASSWORD_PEPPER=$(openssl rand -base64 32) export TRUST_TOKEN_SECRET=$(openssl rand -base64 32) -
Update Helm Dependencies: Download remote chart dependencies.
helm dependency update ./charts/proboSources: contrib/helm/README.md:28-29
-
Install the Chart: Use
helm installto deploy Probo, providing the generated secrets and connection details for your external services.helm install my-probo ./charts/probo \ --set probo.baseUrl="probo.example.com" \ --set probo.encryptionKey="$ENCRYPTION_KEY" \ --set probo.auth.cookieSecret="$COOKIE_SECRET" \ --set probo.auth.passwordPepper="$PASSWORD_PEPPER" \ --set probo.trustAuth.tokenSecret="$TRUST_TOKEN_SECRET" \ --set postgresql.host="postgres.example.com" \ --set postgresql.password="<db-password>" \ --set s3.bucket="probo-production" \ --set s3.accessKeyId="<aws-access-key-id>" \ --set s3.secretAccessKey="<aws-secret-access-key>"
Production Configuration
For production, it is recommended to use a values.yaml file to manage configuration. The chart includes options for ingress, autoscaling, SMTP, and more.
Key Configuration Parameters
The following table lists some of the most important parameters that must be configured for a production deployment.
| Parameter | Description | Default Value |
|---|---|---|
probo.encryptionKey | Base64-encoded encryption key (32+ bytes) | "" |
probo.auth.cookieSecret | Cookie signing secret (32+ bytes) | "" |
probo.auth.passwordPepper | Password hashing pepper (32+ bytes) | "" |
probo.trustAuth.tokenSecret | Trust token secret (32+ bytes) | "" |
postgresql.host | PostgreSQL hostname | "" |
postgresql.password | PostgreSQL password | "" |
s3.accessKeyId | S3 access key ID | "" |
s3.secretAccessKey | S3 secret access key | "" |
ingress.enabled | Enable Kubernetes Ingress | false |
probo.mailer.smtp.addr | SMTP server address for sending emails | "" |
Sources: contrib/helm/charts/probo/README.md:65-76
Container Configuration (Environment Variables)
When running Probo in a container (via Docker or Kubernetes), its behavior is configured through environment variables. The entrypoint.sh script reads these variables and generates a config.yml file.
The following table details key environment variables and their purpose.
| Environment Variable | Description | Required |
|---|---|---|
PROBOD_ENCRYPTION_KEY | The main key for data encryption. | Yes |
AUTH_COOKIE_SECRET | Secret for signing authentication cookies. | Yes |
AUTH_PASSWORD_PEPPER | Pepper used for hashing user passwords. | Yes |
TRUST_AUTH_TOKEN_SECRET | Secret for signing trust center access tokens. | Yes |
PROBOD_BASE_URL | The public base URL of the application. | No |
PG_ADDR | Address of the PostgreSQL database. | No |
PG_USERNAME | Username for the PostgreSQL database. | No |
PG_PASSWORD | Password for the PostgreSQL database. | No |
PG_DATABASE | The name of the PostgreSQL database. | No |
AWS_BUCKET | The S3 bucket name for object storage. | No |
AWS_REGION | The AWS region for the S3 bucket. | No |
AWS_ACCESS_KEY_ID | Access key for S3. | No |
AWS_SECRET_ACCESS_KEY | Secret access key for S3. | No |
AWS_ENDPOINT | Custom S3-compatible endpoint. | No |
SMTP_ADDR | SMTP server address for email notifications. | No |
OPENAI_API_KEY | API key for OpenAI to enable AI features. | No |
Sources: entrypoint.sh:17-101