Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
14 changes: 8 additions & 6 deletions PACKAGE-INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

Repository-backed installation commands for DocumentDB.

> This repository serves v0.117-0. v1.0-RC1 is for testing only, gets no fixes (those go into
> RC2 or 1.0), has no upgrade path, and isn't in this repository; see
> This repository serves v0.117-0. v1.0-RC2 is for testing only, gets no fixes (those go into
> a later RC or 1.0), has no upgrade path, and isn't in this repository; see
> [Try the 1.0 release candidate](https://documentdb.io/docs/getting-started/release-candidate/).

## Clean-host installer
Expand All @@ -16,10 +16,12 @@ sudo sh documentdb-install.sh
```

This installs v0.117-0 from this repository on PostgreSQL 18; add `--pg-major 17`
for 17. To try RC1, add `--version v1.0-RC1`, or use the `pgNN-1.0-rc1` container image. The installer then
downloads this host's packages from the
[v1.0-RC1 release](https://github.com/documentdb/documentdb/releases/tag/v1.0-RC1),
verifies them against its `SHA256SUMS`, and doesn't use this repository. See the
for 17. To try RC2, add `--version v1.0-RC2`. The installer then downloads this host's
packages from the
[v1.0-RC2 release](https://github.com/documentdb/documentdb/releases/tag/v1.0-RC2),
verifies them against its `SHA256SUMS`, and doesn't use this repository. The
`pgNN-1.0-rc2` container image also runs RC2; it sends anonymous usage telemetry by default
(opt out with `-e DOCUMENTDB_USAGE_TELEMETRY=false`). See the
[RC guide](https://documentdb.io/docs/getting-started/release-candidate/).

The site serves the `install.sh` attached to the release named in
Expand Down
11 changes: 6 additions & 5 deletions app/services/articleService.ts
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@ The current official release publishes the full stack — extension, gateway, se
> Need another distribution or PostgreSQL major? We welcome community builds. Check out the matching release tag and use the version-parameterized [packaging scripts](https://github.com/documentdb/documentdb/blob/v0.117-0/packaging/README.md). \`build_packages.sh\` builds the extension, \`gateway/build_gateway_packages.sh\` builds the gateway, and \`build_extra_packages.sh\` builds the common, tools, stand-alone, and meta packages. PostgreSQL 15 is extension-only because the setup tools require PostgreSQL 16 or newer. These builds are on demand and are not official release assets hosted by documentdb.io.

> [!NOTE]
> Want to try DocumentDB 1.0? [v1.0-RC1](/docs/getting-started/release-candidate) is for testing only, gets no fixes (those go into RC2 or 1.0) and has no upgrade path. It isn't in the package repository, so the commands below install v0.117-0.
> Want to try DocumentDB 1.0? [v1.0-RC2](/docs/getting-started/release-candidate) is for testing only, gets no fixes (those go into a later RC or 1.0) and has no upgrade path. It isn't in the package repository, so the commands below install v0.117-0.

You do not need PostgreSQL already installed — the setup wizard creates and manages its own instance. The install does add the PGDG repository and pull PostgreSQL, PostGIS and around 160 packages (about 140 MB), so pick a host you are willing to have PGDG on.

Expand All @@ -205,9 +205,10 @@ sudo sh documentdb-install.sh
\`\`\`

This installs v0.117-0 from the package repository on PostgreSQL 18; add \`--pg-major 17\` for 17.
To try RC1, run \`sudo sh documentdb-install.sh --version v1.0-RC1\` instead, or use the \`pgNN-1.0-rc1\` container image.
It downloads this host's packages from the [v1.0-RC1 release](https://github.com/documentdb/documentdb/releases/tag/v1.0-RC1), verifies them against its \`SHA256SUMS\` and doesn't use the package repository. See the [RC guide](/docs/getting-started/release-candidate).
RC1 gets no fixes and has no upgrade path, so use a clean host.
To try RC2, run \`sudo sh documentdb-install.sh --version v1.0-RC2\` instead.
It downloads this host's packages from the [v1.0-RC2 release](https://github.com/documentdb/documentdb/releases/tag/v1.0-RC2), verifies them against its \`SHA256SUMS\` and doesn't use the package repository.
The \`pgNN-1.0-rc2\` container image also runs RC2; it sends anonymous usage telemetry by default (opt out with \`-e DOCUMENTDB_USAGE_TELEMETRY=false\`). See the [RC guide](/docs/getting-started/release-candidate).
RC2 gets no fixes and has no upgrade path, so use a clean host.

## Install

Expand Down Expand Up @@ -1258,7 +1259,7 @@ The \`latest\` tag is a convenience alias. Pin an explicit tag for anything repr
| \`ghcr.io/documentdb/documentdb/documentdb-local:pg18-0.117.0\` | DocumentDB 0.117.0 on PostgreSQL 18 |
| \`…:pg17-0.117.0\` | DocumentDB 0.117.0 on PostgreSQL 17 |
| \`…:pg16-0.117.0\` · \`…:pg15-0.117.0\` | PostgreSQL 16 and 15 |
| \`…:pg15-1.0-rc1\` · \`…:pg16-1.0-rc1\` · \`…:pg17-1.0-rc1\` · \`…:pg18-1.0-rc1\` | [v1.0-RC1](https://github.com/documentdb/documentdb/releases/tag/v1.0-RC1), for testing only, with [no fixes to RC1 and no upgrade path](/docs/getting-started/release-candidate). No date for 1.0 yet. Use a new, empty data volume. |
| \`…:pg15-1.0-rc2\` · \`…:pg16-1.0-rc2\` · \`…:pg17-1.0-rc2\` · \`…:pg18-1.0-rc2\` | [v1.0-RC2](https://github.com/documentdb/documentdb/releases/tag/v1.0-RC2), for testing only, with [no fixes to RC2 and no upgrade path](/docs/getting-started/release-candidate). No date for 1.0 yet. Use a new, empty data volume. Sends anonymous usage telemetry by default; see the [privacy statement](https://github.com/documentdb/documentdb/blob/v1.0-RC2/documentdb-local/PRIVACY.md) to opt out. |
| \`…:latest\` | Currently identical to \`pg17-0.117.0\` |

> \`latest\` tracks **PostgreSQL 17**, while the \`documentdb\` package on Linux pins
Expand Down
2 changes: 2 additions & 0 deletions blogs/_posts/2026-10-01-versioning.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ These experimental versions are not intended for long-term use, nor will they be

### Release candidate installation

> **Update:** [v1.0-RC2](https://github.com/documentdb/documentdb/releases/tag/v1.0-RC2) replaces RC1 for testing. Use `rc2` and `v1.0-RC2` in place of `rc1` and `v1.0-RC1` below. The RC2 image sends anonymous usage telemetry by default; add `-e DOCUMENTDB_USAGE_TELEMETRY=false` to opt out.

With Docker:

```bash
Expand Down
6 changes: 3 additions & 3 deletions scripts/publish-installer.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@ import { mkdir, writeFile } from 'node:fs/promises';
import { resolve } from 'node:path';
import { pathToFileURL } from 'node:url';

// v0.117-0 ships no installer; RC1's installs from the stable repository.
// v0.117-0 ships no installer; RC2's installs from the stable repository.
// Release assets can be replaced, so the digest is pinned too.
export const installerSource = {
release: 'v1.0-RC1',
sha256: 'dfacd0cd85ad23de191dee9d39b8fc5b4abe9cf1da7db75ea539ad487a2e9f34',
release: 'v1.0-RC2',
sha256: 'b9d16b3b86d3b1541e701be0ce38086dcb0bc904f761a36c7ede9fefe91d45f2',
};

export async function publishInstaller(outputDirectory = 'out') {
Expand Down
5 changes: 3 additions & 2 deletions tests/packageArticles.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -283,11 +283,12 @@ describe('Linux package articles', () => {
expect(new Set(tags)).toEqual(new Set([FALLBACK_RELEASE.tagName]));
});

it('serves the stable installer and selects RC1 only with --version', () => {
it('serves the stable installer and selects RC2 only with --version', () => {
expect(linuxPackagesGuideContent).toContain('https://documentdb.io/install.sh');
expect(linuxPackagesGuideContent).toContain('installs v0.117-0 from the package repository');
expect(linuxPackagesGuideContent).toContain('sh documentdb-install.sh --version v1.0-RC1');
expect(linuxPackagesGuideContent).toContain('sh documentdb-install.sh --version v1.0-RC2');
expect(linuxPackagesGuideContent).toContain("doesn't use the package repository");
expect(linuxPackagesGuideContent).toContain('DOCUMENTDB_USAGE_TELEMETRY=false');
});

it('uses the current release package guide and artifact version', () => {
Expand Down
Loading