Skip to content

Commit 2e5ae0e

Browse files
docs: Update authentication docs (#240)
1 parent 78e6964 commit 2e5ae0e

File tree

1 file changed

+5
-12
lines changed

1 file changed

+5
-12
lines changed

docs/development.md

Lines changed: 5 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ for **Fleet Routing App**.
66
## Google Cloud Project Setup
77
🛑 Before you can run the app,
88
you will need access to a Google Cloud project
9-
with **Optimization API** other required services enabled.
10-
You will also need **Service Account** and **API Key** credentials
11-
to authenticate requests.
9+
with **Optimization API** and other required services enabled.
10+
You *may* also need a **Service Account** and **API Key** credentials
11+
to authenticate requests. See the [*Authentication*](#authentication) section for more details.
1212

1313
> ⏭️ If you have already [deployed an instance](deployment.md)
1414
> of **Fleet Routing App** to a Google Cloud project,
@@ -167,8 +167,8 @@ Populate `application/.env` file with the details of your Google Cloud project a
167167
| API_ROOT | URL of the backend API (probably `http://localhost:8080/api`) | |
168168
| FRONTEND_PROXY | URL of the frontend Angular development server (probably `http://localhost:4200/`) - *FOR DEVELOPMENT USE ONLY* | |
169169
| MAP_API_KEY | API Key to load Google Maps JavaScript API in frontend (see [*Authentication*](#authentication) section) | |
170-
| GOOGLE_APPLICATION_CREDENTIALS | Path to a service account credentials JSON file to authenticate Google API requests (see [*Authentication*](#authentication) section) | *Default application credentials* |
171170
| **Optional** | | |
171+
| GOOGLE_APPLICATION_CREDENTIALS | Path to a service account credentials JSON file to authenticate Google API requests (see [*Authentication*](#authentication) section) | *Default application credentials* |
172172
| LOG_FORMAT | Log format to output (`google` or `pretty`) | `google` |
173173
| LOG_LEVEL | Minimum [Pino log level](https://getpino.io/#/docs/api?id=level-string) to output | `info` |
174174
| GRPC_TRACE | gRPC component(s) to show internal logs for (or set to `all` to log every component). *See [gRPC Troubleshooting guide](https://github.com/grpc/grpc/blob/master/TROUBLESHOOTING.md)*. | If not set, no internal gRPC logs are enabled |
@@ -194,17 +194,10 @@ LOG_FORMAT=pretty
194194
#### Service Account Credentials
195195
To authenticate requests to **Route Optimization**,
196196
the backend needs credentials for a Google Cloud service account
197-
with the **Route OptimizationEditor** role.
197+
with the **Route OptimizationEditor** role. These credentials are provided using [Application Default Credentials](https://cloud.google.com/docs/authentication/application-default-credentials) in the application environment. See the official docs for how to configure application credentials.
198198

199199
> **Route Optimization** requests cannot be authenticated with end-user credentials.
200200
201-
[Create a JSON service account key](https://cloud.google.com/iam/docs/creating-managing-service-account-keys#creating_service_account_keys)
202-
for the *Fleet Routing App Service Account (`fleetrouting-app@`)*
203-
in your project. Save it to your machine
204-
and set the absolute path of the downloaded credentials JSON file
205-
as the `GOOGLE_APPLICATION_CREDENTIALS` environment variable
206-
(see [*Configure Environment Variables*](#configure-environment-variables) section).
207-
208201
#### API Key for Google Maps
209202
To load **Google Maps JavaScript API**
210203
and make other requests to Google Maps Platform APIs,

0 commit comments

Comments
 (0)