Skip to content

glowcap v0.1.5 alpha

Pre-release
Pre-release

Choose a tag to compare

@github-actions github-actions released this 07 Nov 22:20
· 136 commits to dev since this release
Immutable release. Only release title and notes can be modified.
v0.1.5
36f2547

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.5

Added

  • The Rooms page is published at https://glowcap.org/rooms/app/ with the
    website. A Rooms server lets that page use it unless --allow-origin (or
    GLOWCAP_RELAY_ALLOW_ORIGINS) lists other pages. The link it prints under
    open the page opens the page with this server. The page names the
    browser's local network permission when that is what stands in the way.
  • --http-public (or GLOWCAP_ROOMS_HTTP_PUBLIC) names the address browsers
    reach a Rooms server at, so the links a deployed server prints are ones
    other people can open.
  • The Rooms server card in Settings shows the server's address to copy.
  • The theme chosen on the website or in the Rooms page it publishes is one
    choice: both keep it under the same browser key. A presentation export
    still carries it with the other view preferences.
  • Joining a room, connecting to a directory, or messaging someone from a page
    with no Rooms server asks for one in place, the way Attach does, and the
    page comes back to that act once the server is saved.
  • rooms-web --export-static=<directory> --base=<path> writes the page as
    plain files for any static host. It replaces only an export it wrote, and
    a failed export leaves the one in place untouched.
  • A session's home directory is chosen in Settings. A room joined without a
    directory address opens there, the choice is offered again after a Rooms
    server restart, and a home that stopped answering stays visible.

Changed

  • The release workflow points the Racket package catalog at each release's
    binding archive and installs the package from the catalog, so a release
    reaches Racket users without a maintainer editing the catalog entry.
  • --allow-origin= with an empty value lets no other page in, and an option
    given without its value names the form the help shows.
  • A session opens without a relay, and a page that did not open says why,
    with Reload on a tab that has chosen no session.
  • Closing a Rust browser channel answers only a failure to retire the socket
    itself. A channel that failed earlier closes cleanly, and that first failure
    stays the answer to its reads and writes.

Every release is listed in the changelog.

Choose a download

For the CLI, Rooms, and agent skills, choose CLI + Rooms.
Its filename starts with glowcap-v0.1.5-. The C SDK starts with
glowcap-c-v0.1.5- 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.

For browser applications, download the browser bundle.
It includes prebuilt JavaScript, matching Wasm, and an example page. Extract
it into a new directory your web server serves and open index.html.

The Rust crate downloads the WebAssembly libraries
automatically when targeting wasm32-unknown-unknown. The archive includes
the matching C headers.

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.5 sh

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

archive=glowcap-v0.1.5-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.5 --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:b47e0c5bd0d87dddda8f1387dbd94f9bc35ad54148348dfdc23282c5ad0367e8. 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:b47e0c5bd0d87dddda8f1387dbd94f9bc35ad54148348dfdc23282c5ad0367e8 --repo glowcap-org/glowcap

Install a language package

Each package is version 0.1.5 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.5
pip install glowcap==0.1.5
deno add jsr:@glowcap/runtime@0.1.5 jsr:@glowcap/tcp@0.1.5
raco pkg install glowcap

Deno's default dependency-age policy
delays new versions for 24 hours. Add an exception for the glowcap packages if
you need this release sooner.

The publish workflow uploads
the packages and points the Racket catalog's glowcap entry at this release's
source package. It 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.5 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: 36f25472c8b38a8e132bc5372d53cce2fee7d053. Release run.