Skip to content

docs: clarify DB env overrides #146

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

Open
dex-the-ai wants to merge 3 commits into
base: main
Choose a base branch
from
Open

docs: clarify DB env overrides #146

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
41ee7b4
docs: clarify DB env overrides
dex-the-ai Jul 7, 2026
178a96c
Clarify ASP.NET env var requirements
dex-the-ai Jul 7, 2026
4faad18
ci: don't fail PR on Slack notify step
dex-the-ai Jul 8, 2026
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
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Specifically, you need to do the following:
- Create the [database credentials](https://docs.couchbase.com/cloud/clusters/manage-database-users.html) to access the travel-sample bucket (Read and Write) used in the application.
- [Allow access](https://docs.couchbase.com/cloud/clusters/allow-ip-address.html) to the Cluster from the IP on which the application is running.

All configuration for communication with the database is stored in the [appsettings.Development.json](https://github.com/couchbase-examples/aspnet-quickstart/blob/main/src/Org.Quickstart.API/appsettings.Development.json) file. This includes the connection string, username, password, bucket name and scope name. The default username is assumed to be `Administrator` and the default password is assumed to be `P@$$w0rd12`. If these are different in your environment you will need to change them before running the application.
For local development, the default Couchbase configuration lives in the [appsettings.Development.json](https://github.com/couchbase-examples/aspnet-quickstart/blob/main/src/Org.Quickstart.API/appsettings.Development.json) file. This includes the connection string, username, password, bucket name, and scope name. The application also honors the `DB_CONN_STR`, `DB_USERNAME`, and `DB_PASSWORD` environment variables; when those are set, they override the file values at runtime.
Comment thread
dex-the-ai marked this conversation as resolved.
Outdated

```json
"Couchbase": {
Expand Down Expand Up @@ -140,7 +140,7 @@ If you would like to add another entity to the APIs, these are the steps to foll

If you are running this quickstart with a self managed Couchbase cluster, you need to [load](https://docs.couchbase.com/server/current/manage/manage-settings/install-sample-buckets.html) the travel-sample data bucket in your cluster and generate the credentials for the bucket.

You need to update the connection string and the credentials in the [appsettings.Development.json](https://github.com/couchbase-examples/aspnet-quickstart/blob/main/src/Org.Quickstart.API/appsettings.Development.json) file in the source folder.
You need to provide the connection string and credentials either in [appsettings.Development.json](https://github.com/couchbase-examples/aspnet-quickstart/blob/main/src/Org.Quickstart.API/appsettings.Development.json) or via the `DB_CONN_STR`, `DB_USERNAME`, and `DB_PASSWORD` environment variables before running the app.
Comment thread
dex-the-ai marked this conversation as resolved.
Outdated

> **NOTE:** Couchbase must be installed and running prior to running the the ASP.NET app.

Expand Down
Loading