Skip to content

Document that the API image build needs 6 GiB of Docker memory #86

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
om986 merged 2 commits into from
Oct 13, 2026
Merged

Document that the API image build needs 6 GiB of Docker memory #86

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e9e6b16
Document that the API image build needs 6 GiB of Docker memory.
Oct 13, 2026
51f6880
Shorten the Docker memory note.
Oct 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Thank you for helping build open cloud security tooling.

1. Fork and clone the repo
2. Copy `.env.example` to `.env`
3. Run `docker compose up -d` for local Postgres
3. Run `docker compose up -d` for local Postgres and the API. Give Docker at least 6 GiB of RAM so the API image build can finish.
4. Pick an [open issue](https://github.com/OpenSourceOM/core/issues) or an item from [docs/ROADMAP.md](./docs/ROADMAP.md). For a change that is not tracked yet, open a [discussion](https://github.com/OpenSourceOM/core/discussions) with the `roadmap` label.

## Pull request reviews
Expand Down
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,8 @@ go build -o example-collector ./examples/collector
open http://localhost:8080
```

The API image compiles `github.com/aws/aws-sdk-go-v2/service/ec2`. Give Docker at least 6 GiB of RAM.

`.env.example` sets `OM_API_SECRET=change-me-in-production`, and Compose passes that into the API. In the console, paste that value into the API key field and click **Save API key**. The console then sends it as `X-API-Key` on every `/v1` call except health. Leave the secret empty to keep local API calls open.

**API endpoints:** `GET /v1/health`, `POST /v1/ingest`, `GET /v1/findings`, `GET /v1/graph/snapshot`, `POST /v1/rules/run`, `GET /v1/identity/blast-radius`
Expand Down
1 change: 1 addition & 0 deletions docker-compose.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
# SPDX-License-Identifier: Apache-2.0
# Local dev stack: Postgres + API
# Usage: cp .env.example .env && docker compose up -d
# The API image compiles aws-sdk-go-v2/service/ec2. Docker needs at least 6 GiB of RAM.

services:
postgres:
Expand Down
Loading