Skip to content

glowcap v0.1.6 alpha

Pre-release
Pre-release

Choose a tag to compare

@github-actions github-actions released this 10 Nov 13:17
· 122 commits to dev since this release
Immutable release. Only release title and notes can be modified.
v0.1.6
791ee9f

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

Added

  • glowcap apps rooms page prints the link that opens the Rooms page with
    the running server filled in. rooms-web --page-link and the server's
    /page route answer the same link, and deployment up prints it first.

  • rooms-server and rooms-web announce any of the seven listener
    transports with --transport=<transport>. A relay transport registers at
    --relay=<ws-url> or GLOWCAP_ROOMS_RELAY_URL, and under rooms-web at
    that server's own relay. --relay-public=<ws-url> names that relay as
    peers dial it when a port forward or a proxy gives it another address, and
    rooms-web --http-public=<url> does the same for its own relay. The
    installed glowcap apps rooms commands take the same listener options,
    serve with --listen and the shared session's as --session-<option>,
    and session start keeps every one of them in its settings.

  • rooms-web --session-transport=<transport> chooses the shared session's
    announced listener the same way, and --session-<option> passes any other
    rooms-session option to it. A relay listener registers at that server's
    own relay unless --session-relay names one, an onion listener publishes
    through the private Tor the server runs, and the page is offered the
    session through any listener a browser can open.

  • A relay listener whose configuration names a relay alias advertises the
    alias in its rendezvous-relay hint. Behind a port forward or a proxy,
    peers dial the route they reach while the listener's own register socket
    opens at the route it reaches.

  • The relay admits dials of one registered directory at the rate its peer
    may register, so a tighter registration bound throttles the whole directory.

  • A relay that cannot complete a dial closes the browser's socket with the
    cause, and the page's channel reports that cause instead of a bare
    connection close.

  • rooms-server --listen=<transport>[,<name>=<value>...] (or
    GLOWCAP_ROOMS_LISTEN) opens another listener to the same directory, once
    per transport, and the server starts only once every declared listener is
    open. The address it prints then names the directory by its key with every
    listener listed.

  • The Rooms page reaches a directory through a sealed relay listener the
    directory declares, with no Rooms server chosen, and the directory's card
    says the route the connection took.

Changed

  • --capabilities=all, or --capabilities=<name>[,<name>...], tells
    rooms-server and rooms-web which operator capabilities to mint, with
    GLOWCAP_ROOMS_CAPABILITIES as the variable. It replaces the six flags
    --admin-listeners, --diagnostics, --operator, --peering, --irc, and
    --trace and their variables, so name the capabilities you want in one list.
    A deployment or script that set those variables mints nothing until it
    names the capabilities in GLOWCAP_ROOMS_CAPABILITIES. Reading the kept
    capabilities again is glowcap apps rooms capabilities, or
    rooms-web --print-capabilities, which takes the locators from the running
    web server, from --url, or from GLOWCAP_ROOMS_LOCATOR. rooms-server
    no longer reads them, and glowcap apps rooms directory capabilities is
    gone.

  • The shared session writes its use link to use.sturdyref and its management
    link to management.sturdyref in the state directory, the names every page
    gives those links. The managed deployment's readiness file is
    /run/rooms-session/use.sturdyref. Both files are rewritten at every start,
    so an existing state directory needs no change.

  • Four Rooms page names changed. The Settings tab Reachability is
    Connection. The Operations tab Directory is Operator. The
    Settings act Delete local session is Empty this session, since it
    empties the open session and the browser stays on it, and the shared
    session's Reset shared session is Empty this session for everyone
    for the same reason.

  • Rooms page copy says link, session, and message where it said capability,
    workspace, and line. On a room card, the Capabilities tab is Links,
    and every button on it grants, revokes, or discards a link.

  • The Rooms deployment's managed Compose file holds only the settings every
    deployment shares. Every setting a host chooses lives in
    docker-compose.override.yml: the public address, allowed pages, trusted
    proxies, trace routes, TURN, and admission overrides. The example override
    shows public hosting behind an HTTPS proxy. A variable exported in the
    shell that runs deployment up does not reach the services: move it
    into the override.

  • glowcap apps rooms deployment reset directory names the unit that was
    state, and deployment up prints the directory locator and the shared
    session's use link and management link under those names.

  • Delete browser data in the Rooms page also forgets every Rooms
    preference this browser kept: the chosen server, other tabs' session
    choices, and the theme. Other open Rooms tabs reload.

  • Every exported symbol of the nine @glowcap JSR packages carries a doc
    comment, including the generated C ABI constants and struct layouts, so
    each package's documentation score on jsr.io reports no undocumented
    symbol.

  • A page with no Rooms server asks for one only for an address the browser
    cannot open itself, and says which listener failed when one did. A relay
    that does not answer is named on the join card.

  • Every ask for a Rooms server says what the act needs one for. The needs
    are an address this browser cannot open on its own, the home directory a
    blank address means, a link other people reach this browser through, and
    direct messages in the mode that goes through the server.

  • Attaching to a session, holding a management control, taking an archive
    peer, and holding an operator capability judge the pasted link by the
    listeners its address names, so a session shared from another browser
    attaches with no Rooms server. The ask comes only for a link this browser
    cannot open on its own, and a break on the way to a session reached through
    its relay listener names that relay.

  • A blank directory address on a page with no Rooms server is refused on its
    own field instead of asking for a server.

  • The Session tab offers its unfinished-changes list only while a change is
    unfinished, and the Connection tab drops this browser's own address,
    which nothing on the page accepted.

  • rooms-web serves its page before its directory is up, so the directory's
    relay listeners can register with it, and /locator waits for the directory
    instead of answering that there is none.

  • GLOWCAP_ROOMS_SESSION_STATE serves the shared session the way
    --session-state does, and the option wins when both are set.

  • The host bindings in Rust, TypeScript, and Racket name a transport they have
    no connector for as UnknownTransport, the name the Zig host uses for the
    same condition, so one reader recognizes it from every binding.

  • A C ABI content registration holds up to 128 methods, where it held 64. A
    registration over the cap is refused with GLOWCAP_ERR_INVALID_ARGUMENT
    and the last error loam: TooManyMethods, so a too-long method table is
    told apart from a missing callback.

  • rooms-web prints one block at startup: the addresses first, then the
    links to keep private under their own heading. A directory it runs hands
    its ROOMS-* links to that block, and a restarted directory prints its
    new links under the same heading. The directory's work budgets and their
    counts read on the operator page under Work budgets. The HTTP,
    browser, and session budgets come from your own arguments and are not
    printed.

  • The operator page's Rooms and their links section lists every room
    someone is in and every room a link or a saved record stands for,
    including rooms nobody is in, one line per room with a tag for each link
    that stands. Links… opens a card for that room where each link is
    issued, copied, and revoked. Forget room removes the room entirely:
    its members, every link, its subject, its kept messages, its name, and its
    settings. An IRC bridge's row takes no manager link and cannot be
    forgotten here, and says so. A room's row carries each link itself in
    place of an issued flag, and issuing a link answers the row as data, so
    nothing enters the session's storage. The factory reset says that it
    clears manager links too.

  • Anyone in a room can take its manager link or moderator link there,
    however they came in, and the room card's links tab says so. A room
    answers its identity digest and its manager's identity to anyone in it,
    which is how a link is checked against the room. A digest opens nothing.

  • Commands answer where you typed them. /link, /moderator, /kick,
    /subject, /msg, and /invite say the link, the refusal, or the way in,
    in the conversation. /link <room> for another room you are in answers in
    place, and for one you are not in says to join it first. /invite in a
    room you joined by name says the room is not yours to hand on and names
    the way in.

  • /msg and /invite to a name nobody registered say so. /whois in a
    direct message answers about the person on the other end. Sending a third
    line while two are still on their way says so.

  • Commands take exactly their arguments. /msg, /invite, /kick,
    /whois, /ignore, and /unignore take one name, with or without @,
    and the completion list sends on the first Enter when the argument is
    written out. /leave, /clear, /details, /members, /help,
    /directories, /quit, and /delete take none. A line that looks like a
    command but names none, such as /ignored or /msg@bob, is refused with
    a pointer to /help. Text that cannot be a command, such as /etc/hosts,
    is still a message.

  • /link <room> names a listed room you are in and answers the link you
    hold for it. A link is created from inside the room itself.

  • A page opened without the Share keys and links permission says so
    where a link would show, in the room card's links tab and from /link.

Fixed

  • Every Rooms tab, including a reloaded one, shows and shares the address
    each directory was dialed through instead of its bare identity. A page
    opened with any access link reads that address, never the link's secret.

  • Under rooms-web, the directory and the shared session dial the server's
    own relay at the address --http-public names, which reaches both of
    them. rooms-web refuses --relay-public and --session-relay-public
    for a peer on its own relay. An address given to one peer left the other
    dialing the relay's bound address, and a shared session in a container
    then answered a directory join with a bare PromiseBroken. Both options
    still apply to a peer whose --relay or --session-relay names another
    relay.

  • A saved directory, room, or direct conversation the shared session refuses
    to start is reported once as a standing refusal when its code says the
    condition clears only with a change. It is started again only on an
    explicit retry or a changed row, and the session's recovery timer rests
    while only such refusals stand. A saved address on a transport the session
    does not dial is one such refusal, saved-transport-unavailable. Before,
    the session dialed the address on every recovery wake and told the operator
    a bare RestorationFailed: UnknownTransport every few seconds. Enter the
    directory's current address on its card to re-route it.

  • The page frees a change the session refused and reports the reason, for
    every kind of change it submits. Before, it listed such a change as gone
    through, with a Finish that resubmitted it. A change that went through
    but could not be shown here can be let go, and stays saved in the
    session. A change nothing settled is listed with its outcome unknown and
    can be let go.

  • New access and Prepare control from a held management control ask
    for a Rooms server only when the control is this browser's own, whose links
    lead here. Any other control, such as one for a session attached by its own
    address, publishes the access at the session it manages.

  • A sturdyref naming a peer by its key through a sealed listener, such as a
    directory's bare noise-relay address, redeems over the sealed session
    whatever listener the peer's hello advertised. Before, the Rooms page
    failed such a join with PeerIdentityMismatch.

  • A directory address typed on the join card re-routes a directory the
    session already holds. The capability is fetched through the listeners the
    typed address names and replaces the held one under the same id, and a
    directory that was your home directory stays it. Before, the held route was
    kept whatever was typed, so a page with no Rooms server asked for one when
    that route needed a server. The held route typed again changes the nickname
    at most.

  • A keyed-tcp or noise-tcp directory under rooms-web is forwarded to
    from the page the server serves. Before, the server announced no local
    endpoint for those listeners and the relay answered directory forwarding unavailable.

  • Saving an operator capability whose address names the directory by a
    key its listener does not prove (keyed-relay, keyed-tcp) says so and
    names the listeners that prove it, where it showed a bare
    PeerIdentityUnverified.

  • The relay transport and the Rooms server reject TLS certificate paths
    through the distrusted emSign intermediates (rustls-webpki 0.103.16,
    RUSTSEC-2026-0382).

  • rooms-web took the last of a repeated option and dropped the rest without
    a word, so --allow-origin given twice let only the second page in. It
    reads its options the way every other Rooms command does. A repeated option,
    an unknown one, or a port named both as an option and positionally is
    refused by name. --allow-origin repeated extends the list, the same as one
    comma-separated list. The defaults zig build rooms-web and rooms-dev
    supply arrive as environment, so an option typed after -- is the only one
    of its name. rooms-dev names the backend options it owns instead of letting
    rooms-web refuse them as repeats.

  • A forwarded call inside a Rooms server kept no delivering
    session, so the directory card showed no transport and direct messages from
    different senders counted as one sender. current_session() in the Rust
    binding names that session.

  • /join with the link of a room you are already in keeps that one row in
    the sidebar and your place in it, and the link becomes the room's way
    back in after a restart. It added a second row for the same room.

  • The operator page lists a room nobody is in while a link or its record
    stands, issues its manager link there, and Forget room removes it. A
    room nobody was in kept refusing a revoked manager link with no row to
    see, a manager link could be made only from inside the room, and a room
    made through a manager link kept its row after every link was revoked.

  • Closing a room from the operator page reaches every member's sidebar: the
    row drops its roster, shows that you are not in the room, and the room
    says an operator removed it. The row looked unchanged.

  • The operator page's resets and row removals keep the operator's own
    nickname and connection. A factory reset took the name away, which left
    the page unable to act under it.

  • The operator page's Browser trouble list shows a failure nobody has
    worded exactly as the browser reported it. It added advice to try again
    when no action had been taken.

  • A room handed to you by /invite showed an empty room link, and revoking
    it failed with a code. The room card now says the room was handed to you,
    that /invite hands it on, and that a room manager can create a link.
    /link from such a room says the same, and a manager creates the link
    from there.

  • /leave #other left the room you were in. /kick, /moderator, and
    /link showed a generic failure notice with the reason lost. A manager or
    moderator link taken by someone who entered by name or by invitation was
    refused with a code and no words.

  • /invite sends the room link when you hold one, so the invited person
    keeps the room across a refresh. It handed a live reference that ended
    with the page.

  • Forget room refuses before anything changes when the history writer
    is busy. It could drop the room's links and keep its messages. Its kept
    messages are deleted under the name as stored, so a room forgotten by a
    name in another case leaves no file behind.

  • An IRC bridge's row offers no manager link and no Forget room. It
    offered both, and the server refused each after the press.

  • The operator page shows Work budgets when it holds the diagnostics
    capability too. It showed them only without the operator capability.

  • Closing the links card after Forget room leaves focus on the list
    instead of dropping it.

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.6-. The C SDK starts with
glowcap-c-v0.1.6- 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.6 sh

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

archive=glowcap-v0.1.6-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.6 --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:0793b52bf0afe0cf997fcdde9d7c03c469eb9178a82b54ff76d9f7bce9a552e9. 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:0793b52bf0afe0cf997fcdde9d7c03c469eb9178a82b54ff76d9f7bce9a552e9 --repo glowcap-org/glowcap

Install a language package

Each package is version 0.1.6 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.6
pip install glowcap==0.1.6
deno add jsr:@glowcap/runtime@0.1.6 jsr:@glowcap/tcp@0.1.6
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.6 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: 791ee9f770e672d25a12631f88cf4fb484c0d3fd. Release run.