https://github.com/tsmx/gcp-get-env
Simple retrieving of Google Cloud Platform (GCP) provided default process.env variables in cloud functions (gen1 and gen2) and app engine for Node.js 16, 18 and 20.
https://github.com/tsmx/gcp-get-env
Last synced: 21 days ago
JSON representation
Simple retrieving of Google Cloud Platform (GCP) provided default process.env variables in cloud functions (gen1 and gen2) and app engine for Node.js 16, 18 and 20.
- Host: GitHub
- URL: https://github.com/tsmx/gcp-get-env
- Owner: tsmx
- License: mit
- Created: 2023-08-18T20:17:20.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2026-05-06T20:39:50.000Z (29 days ago)
- Last Synced: 2026-05-06T22:32:59.231Z (29 days ago)
- Language: JavaScript
- Size: 489 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# gcp-get-env
> Providing a simple way to retrieve the default `process.env` variables provided by GCP for Node.js [cloud functions](https://cloud.google.com/functions) and [app engine](https://cloud.google.com/appengine) services.
This project contains a simple function/service for retrieving the default `proces.env` variables provided by Google Cloud Platform (GCP) in Node.js for the following services:
- App Engine
- Cloud Functions (Gen1 & Gen2)
Currently, the followoing Node.js runtimes are supported:
- Node.js 16
- Node.js 18
- Node.js 20
## Prerequisites
To follow, along, you'll need:
- An active GCP account
- The `gcloud` CLI installed and configured. See [here](https://cloud.google.com/sdk/docs/install) for help.
Alternatively, use the [endpoints provided by this project](#provided-endpoints) to get the environment variables.
## Deploy and run
The project ships with `npm run` scripts to deploy publicly available endpoints in cloud functions and app engine to retrieve the default environment variables by calling with a simple HTTP `GET` in your browser.
|script name|deploys|function/service name|
|-----------|-------|---------------------|
|`deploy-node16-func`|cloud function with runtime Node.js 16 Gen 1|`node16-get-env`|
|`deploy-node16-func-gen2`|cloud function with runtime Node.js 16 Gen 2|`node16-gen2-get-env`|
|`deploy-node18-func`|cloud function with runtime Node.js 18 Gen 1|`node18-get-env`|
|`deploy-node18-func-gen2`|cloud function with runtime Node.js 18 Gen 2|`node18-gen2-get-env`|
|`deploy-node20-func`|cloud function with runtime Node.js 20 Gen 1|`node20-get-env`|
|`deploy-node20-func-gen2`|cloud function with runtime Node.js 20 Gen 2|`node20-gen2-get-env`|
|`deploy-node16-gae`|app engine service with runtime Node.js 16|`node16-get-env`|
|`deploy-node18-gae`|app engine service with runtime Node.js 18|`node18-get-env`|
|`deploy-node20-gae`|app engine service with runtime Node.js 20|`node20-get-env`|
The output of the gcloud command will show you the URL of the deployed function/service to be called.
To help you being protected from unwanted expenses (keep in mind the endpoints will be **publicly available**!), the deployments will use an maxConcurrency of 1 for the cloud functions and the smallest instance type F1 with a count of 1 for the app engine services.
## Provided endpoints
If you don't want to install in your own GCP account, feel free to call the provided endpoints to get the default environment variables for different services and runtimes*.
|GCP service|Runtime|Environment variables|
|-----------|-------|---------------------|
|Cloud Functions|Node.js 16 Gen1| [Get env vars](https://europe-west3-tsmx-gcp.cloudfunctions.net/node16-get-env)|
|Cloud Functions|Node.js 16 Gen2| [Get env vars](https://europe-west3-tsmx-gcp.cloudfunctions.net/node16-gen2-get-env)|
|Cloud Functions|Node.js 18 Gen1| [Get env vars](https://europe-west3-tsmx-gcp.cloudfunctions.net/node18-get-env)|
|Cloud Functions|Node.js 18 Gen2| [Get env vars](https://europe-west3-tsmx-gcp.cloudfunctions.net/node18-gen2-get-env)|
|Cloud Functions|Node.js 20 Gen1| [Get env vars](https://europe-west3-tsmx-gcp.cloudfunctions.net/node20-get-env)|
|Cloud Functions|Node.js 20 Gen2| [Get env vars](https://europe-west3-tsmx-gcp.cloudfunctions.net/node20-gen2-get-env)|
|App Engine|Node.js 16| [Get env vars](https://node16-get-env-dot-tsmx-gcp.ey.r.appspot.com/)|
|App Engine|Node.js 18| [Get env vars](https://node18-get-env-dot-tsmx-gcp.ey.r.appspot.com/)|
|App Engine|Node.js 20| [Get env vars](https://node20-get-env-dot-tsmx-gcp.ey.r.appspot.com/)|
Note that the environment variables may contain entries specific to your account/project, like `GOOGLE_CLOUD_PROJECT`.
*Without any warranty/guarantee and subject to discontinuation of services.