Skip to content

glowcap v0.1.1 alpha

Pre-release
Pre-release

Choose a tag to compare

@github-actions github-actions released this 02 Nov 06:18
· 233 commits to dev since this release
Immutable release. Only release title and notes can be modified.
v0.1.1
153e593

glowcap is a Zig library for capability-based networking (OCapN and CapTP) and
durable application state, with a CLI, the Rooms chat app, and packages for
Rust, Python, TypeScript, and Racket. This page is the complete release: every
download, how to verify it, and how to install each piece. Read the
documentation, report a problem in the
issues, and report a vulnerability as
SECURITY.md describes.

What changed in 0.1.1

Added

  • Rust, Python, TypeScript, and Racket packages are published from the release
    tag: glowcap on crates.io and PyPI, @glowcap/* on JSR, and glowcap in
    the Racket catalog. Each downloads the C libraries of its version on first
    use and verifies them against the release checksums.
  • Release notes carry a platform download table, verification and install
    steps, a package install section, and this changelog's entry for the version.
  • Every release archive, the checksum file, and the Rooms container image
    carry a build provenance attestation that gh attestation verify checks
    against this repository. The provenance bundle of each download is published
    beside it for offline checks, and the image's software bill of materials is
    attested with the image.
  • The C SDK archive ships a README with a runnable C example.

Changed

  • A binding outside a checkout downloads its own version unless
    GLOWCAP_SKIP_DOWNLOAD is set. Inside a checkout it uses zig-out and
    downloads only with GLOWCAP_DOWNLOAD. The contract's releases_published
    switch is gone.
  • Release archives omit empty directories, and their README and provenance
    links resolve from an extracted archive.

Fixed

  • A release whose archive or image job was skipped is refused instead of
    publishing nothing. Publication can be recovered from the signed tag's
    original run without rebuilding or moving the tag.

Every release is listed in the changelog.

Choose a download

For the CLI, Rooms, browser assets, and agent skills, choose CLI + Rooms.
Its filename starts with glowcap-v0.1.1-. The C SDK starts with
glowcap-c-v0.1.1- and contains headers and libraries for building applications.
The SDK does not contain the CLI or Rooms.

Platform Product Libraries Requires
macOS, Apple Silicon CLI + Rooms C SDK macOS 15.0.0 or newer
macOS, Intel CLI + Rooms C SDK macOS 15.0.0 or newer
Linux, ARM64 CLI + Rooms C SDK glibc 2.39.0 or newer
Linux, x86-64 CLI + Rooms C SDK glibc 2.39.0 or newer

The Linux archives need the glibc version shown or newer. ldd --version prints
yours. Windows and musl distributions such as Alpine have no prebuilt package.
GitHub's automatic Source code downloads contain source for building and are
separate from the compiled downloads above.

Verify and install the product

One command downloads this release for your machine, verifies it against
SHA256SUMS, and runs the product's installer:

curl -fsSL https://glowcap.org/install.sh | GLOWCAP_VERSION=0.1.1 sh

To do the same by hand, download your product archive and SHA256SUMS.
For example, on an Apple Silicon Mac:

archive=glowcap-v0.1.1-aarch64-macos.tar.gz
shasum -a 256 "$archive"

On Linux, choose the Linux archive and use sha256sum "$archive" instead.
Compare the result with the same filename in SHA256SUMS.

Every archive and SHA256SUMS carries a signed build provenance attestation
from this repository's release workflow. With the GitHub CLI 2.49 or newer:

gh attestation verify "$archive" --repo glowcap-org/glowcap

The same check works offline with the bundle published beside each file:

gh attestation verify "$archive" --repo glowcap-org/glowcap --bundle "$archive.sigstore.json"

Then extract into a new directory and install the complete product:

mkdir glowcap-unpacked
tar -xzf "$archive" -C glowcap-unpacked
./glowcap-unpacked/bin/glowcap install
export PATH="$HOME/.local/bin:$PATH"
glowcap help
glowcap apps rooms serve

Open the browser URL printed by serve. Ctrl-C stops the service.
Add the PATH entry to your shell configuration. Keep the installed product's
files together, rather than moving only bin/glowcap. To remove an
installation, delete its directory under ~/.local/lib/glowcap/ and the
~/.local/bin/glowcap link.

macOS executables are not Developer ID signed or notarized. After verification,
use Open Anyway under System Settings, Privacy & Security if macOS
blocks execution. Keep Gatekeeper enabled.

Inside the product, bin/glowcap is the CLI, libexec/ contains Rooms services,
share/glowcap/rooms/ holds browser assets, and share/glowcap/skills/ holds
agent skills. Installation and Rooms commands.

Use the C SDK

Extract the C SDK into an empty directory. Use include/ and lib/ with
your C compiler, following the C ABI guide.
It has no CLI to install. Use libraries from the same SDK build.

Run the Rooms container

The public image supports Linux amd64 and arm64. Docker selects the architecture,
including on macOS with Docker Desktop. This command keeps state in a named volume:

docker run --rm --name glowcap-rooms \
  -p 127.0.0.1:8080:8080 \
  -v glowcap-rooms-state:/state \
  -e GLOWCAP_ROOMS_STATE=/state \
  ghcr.io/glowcap-org/glowcap-rooms:v0.1.1 --http-bind=0.0.0.0

Open http://127.0.0.1:8080. The web port is local to this machine. The directory
uses encrypted iroh discovery and can be reached by peers holding its locator.
For persistent supervised hosting and HTTPS, use the
deployment guide.

The image's digest is sha256:1010fda6d08fd9a930cdad5135ab3b5e1ec10304e80c7e81a040e56434270325. Its build provenance and its software
bill of materials (SPDX) are attested
in the registry:

gh attestation verify oci://ghcr.io/glowcap-org/glowcap-rooms@sha256:1010fda6d08fd9a930cdad5135ab3b5e1ec10304e80c7e81a040e56434270325 --repo glowcap-org/glowcap

Install a language package

Each package is version 0.1.1 and downloads this release's C SDK for its
platform on first use, verified against SHA256SUMS. Set GLOWCAP_LIB_DIR to
an extracted SDK's lib/ to use a local copy instead.

cargo add glowcap@=0.1.1
pip install glowcap==0.1.1
deno add jsr:@glowcap/runtime@0.1.1 jsr:@glowcap/tcp@0.1.1
raco pkg install glowcap

The packages are uploaded by the
publish workflow, which starts
when this page is published and waits for the maintainer's approval at each
registry, so a registry can lag this page by a few hours. The
bindings guide lists every package. Zig users
depend on the v0.1.1 source. The browser files in the
product are the Rooms application, not a published package.

Source and license

Apache-2.0 alpha software. APIs, ABIs, and storage formats may change before 1.0.
Read the project provenance and the LICENSE-APACHE
and LICENSE-THIRD-PARTY files included in each archive.
Source commit: 153e593cc1c871c6c3dd966a557d4afefc6c8965. Release run.