Skip to content

Update tutorial-sync-gateway-manage.adoc #21

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 5 commits into
base: release/2.8
Choose a base branch
from
Open

Update tutorial-sync-gateway-manage.adoc #21

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5706898
Update tutorial-sync-gateway-manage.adoc
iamfortune Jul 9, 2025
2d1b1b3
Merge branch 'release/2.8' into DOC-10860-add-auth-headers
osfameron Jul 15, 2025
69277c2
check tech-comm-team-couchbase
osfameron Jul 15, 2025
5bd283e
Update tutorial-sync-gateway-manage.adoc
iamfortune Jul 15, 2025
10185a1
Update tutorial-sync-gateway-manage.adoc
iamfortune Jul 15, 2025
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
2 changes: 2 additions & 0 deletions modules/ROOT/pages/tutorial-sync-gateway-manage.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,12 +77,14 @@ $ curl -X POST \
http://localhost:4985/_sgcollect_info \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic c3luY19nYXRld2F5OnBhc3N3b3Jk' \
-d '{
"output_dir": "/home/sync_gateway/logs",
"upload": false
}’
----

NOTE: When you set `admin_interface_authentication` to `true` in your Sync Gateway configuration, include authentication headers in your requests.
Copy link

@torcolvin torcolvin Jul 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would drop this line, I'd always expect that especially k8s uses are using admin authentication. If they aren't using authentication (this should never be the case!) then setting a an authorization header is unnecessary.

Especially because this is k8s documentation and they are more likely to have the correct certifcation information, I would have the SG urls always use https, so a find and replace on http://localhost:4985 to https://localhost:4985 would be appropriate.

I even think using tls for non Sync Gateway documentation is correct because folks should always configure Sync Gateway with TLS, and you have to really opt out to do this.

admin_interface_authentication is true by default.

Copy link
Author

@iamfortune iamfortune Jul 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I made some changes to the file.



==== Monitor the status of the log collection
Expand Down