Actions
Bug #23013
closed
Update Google login setup doc for clarity and minor terminology changes
Status:
Resolved
Priority:
Normal
Assigned To:
Category:
Documentation
Target version:
Story points:
-
Release:
Release relationship:
Auto
Description
Proposed updates to our current guide for setting up Google login (https://doc.arvados.org/main/install/setup-login.html#google)
- "6. Add the JavaScript origin:
https://ClusterID.example.com/": This should only include scheme + host (including port if necessary); path (including the trailing slash) is no longer allowed (will fail validation on the Google Developer Console side). In addition, it should make clear that the URI refers to WB2. - "7. Add the Redirect URI:
https://ClusterID.example.com/login": Here the URL should refer to the controller's external URL (so if it's a single node install the port will differ from that of the JavaScript Origin.
Minor changes include
- "Under Authorized domains add your domain (
example.com).": "Authorized domains" now fall under the "Branding" side panel item in the Google Developer Console web UI; - "On the sidebar, click Credentials, then click Create credentials → OAuth client ID": "Credentials" is now "Clients"
Updated by Brett Smith 9 months ago
- Target version set to Development 2025-07-09
- Assigned To set to Zoë Ma
- Status changed from New to In Progress
Updated by Brett Smith 9 months ago
Overall this looks good. Would you be okay with these small copyedits?
diff --git i/doc/install/setup-login.html.textile.liquid w/doc/install/setup-login.html.textile.liquid
index b204db8a7c..86f8068582 100644
--- i/doc/install/setup-login.html.textile.liquid
+++ w/doc/install/setup-login.html.textile.liquid
@@ -31,7 +31,7 @@ Use the <a href="https://console.developers.google.com" target="_blank">Google D
#* Click *Save*.
# On the sidebar, click *Clients*, then click *+ Create client*, arriving at the *OAuth client ID* setup page.
# Under *Application type* select *Web application*.
-# Add the JavaScript origin: @https://ClusterID.example.com@. This refers to the Web origin of the Workbench 2 application (notice that it can only include the schema, hostname, and port parts; the path, in particular a trailing @/@, is not allowed).
+# Add the JavaScript origin: @https://workbench2.ClusterID.example.com@. This should match the Web origin where you will host Workbench. Note that it can only include the schema, hostname, and port parts; the path, in particular a trailing @/@, is not allowed.
# Add the Redirect URI: @https://ClusterID.example.com/login@. The host part of this URI should match the @ExternalURL@ of the Arvados controller service as specified in the configuration file @/etc/arvados/config.yml@, including the port if specified.
# Copy the values of *Client ID* and *Client secret* to the @Login.Google@ section of @/etc/arvados/config.yml@.
The changes are:
- Use the same example URL for Workbench used in the "Install Workbench 2" page later.
- Just call it Workbench, not Workbench 2, since the original is retired so just calling it "Workbench" is preferred now. (I know there's a lot more work to do throughout the documentation to improve this. Of course that's out of scope for this ticket.)
- Promote the parenthetical note to its own sentence, just for simplicity.
If this works for you, I'll commit and merge to main. Thanks.
Updated by
Actions