Fix Linux package install guide and Package Finder#73
Merged
abinav2307 merged 3 commits intomainfrom Apr 30, 2026
Merged
Conversation
Align package docs with the published extension packages and source packaging behavior. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Signed-off-by: Guanzhou Song <guanzhousong@microsoft.com>
…ackage install flow Two high-severity gaps that block new users following /packages and /docs/getting-started/packages in a clean Docker container: 1. apt install hangs on the tzdata postinst prompt when the docs recommend omitting sudo for a clean root container, because the default front-end is interactive. Users are stuck with no visible error. 2. ./scripts/build_and_start_gateway.sh calls tput setaf under set -e -u. In any non-TTY context (docker exec without -t, docker exec -d, nohup, background &, CI) tput aborts the script before the build starts. The error message and absence of any build output make this look like a silent build failure. Verified end-to-end with the new wording in a fresh Ubuntu 22.04 amd64 container (PG 16): apt install completes, gateway builds, and mongosh connects to DocumentDB v0.110-0. Edits: - app/services/articleService.ts: expand the clean-container note, add 'export TERM=xterm' to the host gateway example with a precise comment explaining when to skip it, add an expectation-setter for first-build time, and add two troubleshooting bullets covering both failure modes. - app/packages/page.tsx: APT-only inline tip directing root-container users to run 'export DEBIAN_FRONTEND=noninteractive' as a separate step before the chained apt command (a single-command prefix would not cover the second 'apt install' in the chain). - PACKAGE-INSTALL.md: mirror the same wording so the spec mirror stays in sync with the rendered guide. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
guanzhousongmicrosoft
changed the title
abinav2307
approved these changes
Apr 30, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes the Linux package install experience on
/packagesand/docs/getting-started/packagesso the website matches the packages that are actually published. Repository-backed installs provide the DocumentDB PostgreSQL extension package; they do not currently provide a gateway package, setup helper, or systemd service.The updated guide now gives users a path from package install to successful
mongoshconnectivity: install the extension package, start PostgreSQL with the packaged extension, build/run the gateway from source, and verify the endpoint withmongosh.What changed
documentdb_gateway/documentdb-gatewaypackages from generated APT/RPM commands.documentdb-setupfollow-up flow from the Package Finder UI and package guide.sudo, setDEBIAN_FRONTEND=noninteractivebefore APT commands, install prerequisites andmongoshasroot, then switch to an unprivileged user for PostgreSQL/gateway steps.TERM=xtermworkaround for non-TTY shells and troubleshooting notes for package install/gateway startup issues.PACKAGE-INSTALL.mdaligned with the rendered website package guide.Verification
End-to-end package install flow was tested in a fresh Ubuntu amd64 Docker container:
postgresql-16-documentdb../scripts/start_oss_server.sh../scripts/build_and_start_gateway.sh.mongosh localhost:10260 ...and verifieddb.runCommand({ ping: 1 })returns{ ok: 1 }.Repo checks were run for the changed website files.