Skip to content

DOC-14114-stes-sgw-containers #1000

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
iamfortune wants to merge 1 commit into
base: release/4.1
Choose a base branch
from
Open

DOC-14114-stes-sgw-containers #1000

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
11 changes: 10 additions & 1 deletion modules/start-here/pages/get-started-install-docker.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,12 +114,19 @@ For production deployments, enable TLS and use `couchbases://cb-server` instead.

====

IMPORTANT: {sgw} requires a valid bootstrap config that points to a reachable {cbs} instance to start.
If the config is missing, invalid, or cannot reach {cbs}, the container exits immediately after starting.
The `couchbase/sync-gateway` image always looks for its config at the fixed path `/etc/sync_gateway/config.json` inside the container.
This path is not configurable through an environment variable.
You must mount your config file to this exact path, as shown in the next step, or the container has nothing to load and exits.

=== Run Sync Gateway

Run {sgw} in a Docker container, mounting the configuration file you created.

Replace `/path/to/sync-gateway-config.json` with the absolute path to the file on your local machine.

[[run-sync-gateway]]
[{snippet-header}]
----
docker run -d --name sync-gateway \
Expand All @@ -130,7 +137,9 @@ docker run -d --name sync-gateway \
/etc/sync_gateway/config.json
----

NOTE: Port 4985 is the {sgw} Admin port. By default it is only accessible from within the container. Do not expose port 4985 to external traffic in production environments.
NOTE: This command maps both port 4984, the {sgw} public port, and port 4985, the {sgw} Admin port, to your host machine.
Port 4985 is the Sync Gateway Admin port. By default it is only accessible from within the container.
Do not expose port 4985 to external traffic in production environments.


== Verify the Connection
Expand Down