Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,15 +43,15 @@ ISO ─▶ image_builder ─▶ vagrant ─▶ capture ─▶ updates ─▶ Neo
**Infrastructure** (only needed for capture — see [neogit](https://github.com/OSWatcher/neogit) for setup)

- Neo4j 5.x — graph database where OS snapshots are stored
- Object storage for file contents — neogit defaults to the **local filesystem**, so MinIO (or any S3-compatible store) is optional and only needed for a distributed/production setup like [oswatcher-deploy](https://github.com/OSWatcher/oswatcher-deploy)
- Object storage for file contents — neogit defaults to the **local filesystem**, so MinIO (or any S3-compatible store) is optional and only needed for a distributed/production setup like [oswatcher](https://github.com/OSWatcher/oswatcher)

---

## Two ways in

**🎓 I just want to try it.** Follow the [first-capture tutorial](https://oswatcher.github.io/osw-builder/tutorials/first-capture.html): it walks you from zero to a captured Ubuntu image with a single Neo4j container and no product keys. Budget one to two hours, mostly unattended.

**🏗️ I want to run this for real.** Read the rest of this README, then the [how-to guides](https://oswatcher.github.io/osw-builder/how-to/index.html) for providing ISOs, adding images, and building without capture. For the full OSWatcher infrastructure (Neo4j + MinIO + API + frontend), see [oswatcher-deploy](https://github.com/OSWatcher/oswatcher-deploy).
**🏗️ I want to run this for real.** Read the rest of this README, then the [how-to guides](https://oswatcher.github.io/osw-builder/how-to/index.html) for providing ISOs, adding images, and building without capture. For the full OSWatcher infrastructure (Neo4j + MinIO + API + frontend), see [oswatcher](https://github.com/OSWatcher/oswatcher).

---

Expand Down Expand Up @@ -214,7 +214,7 @@ The full documentation is organised with the [Divio system](https://docs.divio.c

- [neogit](https://github.com/OSWatcher/neogit) — the content-addressed Merkle-tree library that backs capture
- [packer-templates](https://github.com/OSWatcher/packer-templates) — the Packer build templates (a submodule of this repo)
- [oswatcher-deploy](https://github.com/OSWatcher/oswatcher-deploy) — full production stack (Neo4j, MinIO, API, frontend)
- [oswatcher](https://github.com/OSWatcher/oswatcher) — full production stack (Neo4j, MinIO, API, frontend)
- [pywinupdate](https://github.com/OSWatcher/pywinupdate) — standalone WinRM/Ansible Windows Update CLI; independent from the OS-agnostic update orchestration in `osw_builder/updates/`, but scratches a similar itch

## License
Expand Down
2 changes: 1 addition & 1 deletion docs/source/how-to/install-system-deps.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,4 +60,4 @@ sudo libguestfs-test-tool # ends with "libguestfs-test-tool: PASS"

## Infrastructure (separate from system packages)

Capturing to a graph requires a reachable Neo4j instance; object storage defaults to the local filesystem, so MinIO is optional. The quickest way to get Neo4j is a single container — `docker run -p 7474:7474 -p 7687:7687 -e NEO4J_AUTH=neo4j/your-password neo4j:5.26` (see [neogit](https://github.com/OSWatcher/neogit) for details, or [oswatcher-deploy](https://github.com/OSWatcher/oswatcher-deploy) for the full stack with MinIO). If you only want to *build* images and not capture, you can skip this entirely; see {doc}`build-without-capture`.
Capturing to a graph requires a reachable Neo4j instance; object storage defaults to the local filesystem, so MinIO is optional. The quickest way to get Neo4j is a single container — `docker run -p 7474:7474 -p 7687:7687 -e NEO4J_AUTH=neo4j/your-password neo4j:5.26` (see [neogit](https://github.com/OSWatcher/neogit) for details, or [oswatcher](https://github.com/OSWatcher/oswatcher) for the full stack with MinIO). If you only want to *build* images and not capture, you can skip this entirely; see {doc}`build-without-capture`.
2 changes: 1 addition & 1 deletion docs/source/tutorials/first-capture.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ docker run --rm --name osw-neo4j \
Leave it running and confirm you can reach the Neo4j browser at <http://localhost:7474> (log in with `neo4j` / `your-password`).

```{note}
For a full OSWatcher stack with MinIO object storage, an API, and a frontend, use [oswatcher-deploy](https://github.com/OSWatcher/oswatcher-deploy) instead. You do not need it for a first capture.
For a full OSWatcher stack with MinIO object storage, an API, and a frontend, use [oswatcher](https://github.com/OSWatcher/oswatcher) instead. You do not need it for a first capture.
```

## Step 3 — Tell neogit where Neo4j is
Expand Down
Loading