Skip to content

docs(hub): update stable launch guidance #31

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
alliscode merged 1 commit into from
Oct 19, 2026
Merged

docs(hub): update stable launch guidance #31

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion docs/prototype-environment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ Reserve an entire dedicated domain for the hub and its preview subdomains. A sub

### Download and initialize the container deployment

On your Linux server, follow [Download the deployment bundle](../hub/docs/deployment.md#download-the-deployment-bundle) to select an explicit `hub-v*` release, download its bundle and checksum, verify the archive, and extract it into a new deployment directory. Do not use `releases/latest` or skip checksum verification. Check that guide's release-readiness and download-access notes before proceeding; a prerelease bundle is not evidence of production readiness.
On your Linux server, follow [Download the deployment bundle](../hub/docs/deployment.md#download-the-deployment-bundle) to select an explicit stable `hub-v*` release, download its public bundle and checksum, verify the archive, and extract it into a new deployment directory. Do not use `releases/latest` or skip checksum verification. The public release assets do not require GitHub authentication.

From the extracted deployment directory, run:

Expand Down
4 changes: 2 additions & 2 deletions hub/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,12 @@ GitHub stores the source code and decides repository access. The private App let

Replica Hub publishes a public container image at `ghcr.io/github/replica-hub`. The recommended deployment uses the release bundle to run that image with Docker Compose.

The example below selects `hub-v1.0.0-rc.2`, a prerelease, not a generally available (GA) release. No stable Hub release is published yet. See [Deploy Replica Hub](docs/deployment.md#download-the-deployment-bundle) for release availability and setup requirements before deploying.
The example below selects `hub-v1.0.0`, the stable Hub release published on October 15, 2026. Its public release assets do not require GitHub authentication. See [Deploy Replica Hub](docs/deployment.md#download-the-deployment-bundle) for the complete setup requirements.

On a Linux server with `curl`, `tar`, and `sha256sum`, download and verify the bundle before extracting it:

```sh
HUB_RELEASE=hub-v1.0.0-rc.2
HUB_RELEASE=hub-v1.0.0
HUB_RELEASE_URL="https://github.com/github/replica/releases/download/${HUB_RELEASE}"
mkdir replica-hub &&
cd replica-hub &&
Expand Down
6 changes: 3 additions & 3 deletions hub/docs/deployment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,12 +55,12 @@ Set `REPLICA_WELCOME_VIDEO_POSTER_URL` to a direct HTTPS image URL to show a sti

Choose an explicit `hub-v*` release from [Hub releases](https://github.com/github/replica/releases). Do not use `releases/latest`: Hub and canvas releases share this repository, and a canvas release may not contain a Hub bundle.

The example selects `hub-v1.0.0-rc.2`, a prerelease, not a generally available (GA) release. It contains both `replica-deploy.tar.gz` and `replica-deploy.tar.gz.sha256`. No stable Hub release is published yet. For a production deployment, wait for a stable Hub release with both assets, then set `HUB_RELEASE` to that tag. The `curl` commands below do not authenticate, so while the repository is private they return HTTP 404 even for readers with repository access.
The example selects `hub-v1.0.0`, the stable Hub release published on October 15, 2026. It contains both `replica-deploy.tar.gz` and `replica-deploy.tar.gz.sha256`. The Replica repository and its release assets are public, so these downloads do not require GitHub authentication.

Run these commands on a Linux server with `curl`, `tar`, and `sha256sum`:

```sh
HUB_RELEASE=hub-v1.0.0-rc.2
HUB_RELEASE=hub-v1.0.0
HUB_RELEASE_URL="https://github.com/github/replica/releases/download/${HUB_RELEASE}"
mkdir replica-hub &&
cd replica-hub &&
Expand All @@ -76,7 +76,7 @@ The checksum file records the archive's SHA-256 digest, a value calculated from

The bundle contains `compose.yml` and the `replica` command. You do not need to clone the source repository.

The `rc.2` bundle defaults to the major-version image tag `ghcr.io/github/replica-hub:1`. Verifying its archive does not verify that image or establish GA deployment readiness. Before production setup, confirm the stable release's assets and public image are available as described in [Publish a release](testing-and-operations.md#publish-a-release).
The `hub-v1.0.0` bundle defaults to the major-version image tag `ghcr.io/github/replica-hub:1`. See [Image versions](#image-versions) for the stable tags available when running the image without the bundle.

## Create the configuration

Expand Down
Loading