woodstar

module
v0.9.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 22, 2026 License: Apache-2.0

README ΒΆ

woodstar ⭐️

Manages macOS devices with Munki, Santa, and Orbit/osquery.

[!WARNING] This project may be unstable or have bugs, use with caution. Also expect breaking changes between releases for now.

🌱 What's inside

  • Host enrollment, hardware, software, users, and query results
  • Munki repositories, manifests, packages, and assignments
  • Santa rules, client configuration, sync, and events
  • osquery reports, policies, live queries, and dynamic labels
  • Entra directory sync for people, groups, and user affinity
  • Distribution-point workers for local package delivery

πŸš€ Usage

Start with the example environment and a storage capability key:

cp .env.example .env
openssl rand -hex 32
docker compose up -d
docker compose exec woodstar /woodstar user create \
  --email you@example.com \
  --name "Your Name" \
  --role admin

Compose uses the published rolling image. The Docker Compose guide covers certificates, hostnames, storage, and first sign-in.

βš™οΈ Configuration

The documentation covers configuration, client protocols, AutoPkg, and the API.

Use the environment reference and storage guide for deployment settings.

πŸ§‘β€πŸ’» Development

Mise owns the toolchain and commands:

mise install
mise run dev
mise run test
mise run lint

Backend code lives under cmd/woodstar and internal/; the React app lives under web/; the documentation site lives under docs/.

See the development setup and command reference for PostgreSQL, end-to-end, storage, generation, and docs workflows.

πŸ“„ License

Licensed under the Apache License 2.0.

πŸ™ Acknowledgments

  • Munki - Managed software installation for macOS
  • MunkiAdmin - Graphical editor for Munki repositories
  • AutoPkg - Automation framework for macOS software packaging
  • Santa - Binary authorization and endpoint security for macOS
  • osquery - SQL-powered operating system instrumentation
  • Fleet - Open-source device management platform and home of Orbit
  • Zentral - Event-driven platform for endpoint management

Directories ΒΆ

Path Synopsis
cmd
woodstar command
internal
activity
Package activity records the small, curated stream of durable Woodstar actions.
Package activity records the small, curated stream of durable Woodstar actions.
activity/httpapi
Package httpapi exposes the Woodstar activity timeline.
Package httpapi exposes the Woodstar activity timeline.
api
osquery/history
Package history stores the small set of historical osquery status aggregates.
Package history stores the small set of historical osquery status aggregates.
test
e2e/adminapi
Package adminapi provides primitives to interact with the openapi HTTP API.
Package adminapi provides primitives to interact with the openapi HTTP API.
tools
geoipdb command

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL