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
29 changes: 26 additions & 3 deletions getting-started/prebuilt-packages.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,21 @@ and runs setup:

```sh
curl -fsSLo documentdb-install.sh https://documentdb.io/install.sh &&
sh documentdb-install.sh
sudo sh documentdb-install.sh
```

This installs the current release on PostgreSQL 18. Use `--pg-major 17` for PostgreSQL 17.
This installs the current release on PostgreSQL 18. Use `--pg-major 17` for PostgreSQL 17. Run it with `sudo`: started as a normal user, it calls `sudo -v`, which asks for a password even on cloud images whose default user has passwordless sudo.

It asks you to confirm the plan and to choose the admin password. For an unattended run, store the password in a root-owned file and pass `--yes`:

```sh
printf 'DocumentDB admin password: '; IFS= read -r -s PW; echo
printf '%s\n' "$PW" | sudo install -m 600 /dev/stdin /root/documentdb-admin.pw
sudo sh documentdb-install.sh --yes \
--admin-password-file /root/documentdb-admin.pw --accept-external-listen
```

`--accept-external-listen` acknowledges that the gateway listens on all interfaces.
The manual steps below install the same release. To move an existing installation to 1.0, see [Upgrading to 1.0](#upgrading-to-10) instead.

## Set up and connect
Expand Down Expand Up @@ -80,7 +91,7 @@ Enter the password set in the wizard, then run:
db.runCommand({ ping: 1 })
```

The local example accepts the generated self-signed certificate. A bare `-p` prompts for a password; non-interactive scripts must supply a password explicitly.
The local example accepts the generated self-signed certificate. A bare `-p` prompts for a password; non-interactive scripts must supply a password explicitly. `db.version()` reports the MongoDB version DocumentDB is compatible with, not the DocumentDB version; see [Check the version](#check-the-version).

### Optional setup controls

Expand All @@ -95,6 +106,18 @@ The local example accepts the generated self-signed certificate. A bare `-p` pro

Inspect state with `sudo documentdb-setup --pg-version 18 --status`. On systemd, restart this stack with `sudo systemctl restart documentdb-local@18.target`; adopted PostgreSQL retains its own lifecycle. See [Operating a package install](https://documentdb.io/docs/linux-packages/) for TLS and other operational guidance.

### Remove the stack

Delete the instance first, then the packages. `documentdb-local-reset` ships in `documentdb-common`, so it has to run before the purge; purging alone keeps the data directory.

```bash
sudo documentdb-local-reset --pg-version 18 --confirm-destroy
sudo apt purge -y '*documentdb*' # Ubuntu
sudo dnf remove -y '*documentdb*' # EL9
```

The reset is irreversible and only covers the stand-alone stack's private instance, not an adopted PostgreSQL. Open remove and purge problems are tracked in [#771](https://github.com/documentdb/documentdb/issues/771).

## What each release publishes

`N` is the PostgreSQL major version. The package manager installs the dependencies of your selected package.
Expand Down
1 change: 1 addition & 0 deletions getting-started/release-notes-1.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ The SQL extension version is `1.0-0` everywhere, and `hello` reports it in `inte
- **A write can be applied twice** ([#767](https://github.com/documentdb/documentdb/issues/767)). If the backend connection is lost after a write commits but before the reply, the gateway retries it, so a non-idempotent update such as `$inc` can be applied twice even with `retryWrites=false`.
- **`$lookup` can fail on a collection with a wildcard index** ([#769](https://github.com/documentdb/documentdb/issues/769)), with `Unrecognized BSON data type code 0`.
- **Collation is off by default.** `find`, `aggregate`, `count` and `delete` with a `collation` fail as unsupported unless `documentdb_core.enableCollation` is on. `distinct`, `findAndModify` and `update` don't support `collation` at all.
- **Harmless errors in the container log.** The health check logs `FATAL: database "documentdb" does not exist` about every 30 seconds, and startup logs one `Failed to accept a TCP connection (IPv6)` error. Neither affects the server.
- **Container options that do nothing.** `--log-level` and `--enable-telemetry` are validated but have no effect, and a `--data-path` that contains a space fails.
- **Open packaging and container issues:**
- [#771](https://github.com/documentdb/documentdb/issues/771): package remove, purge, upgrade and rerun paths that can leave the stack down or stuck.
Expand Down