enable config via environment variables

whummer · whummer · commit 13963e699df0 · 2022-10-14T01:44:33.000+02:00
diff --git a/README.md b/README.md
@@ -18,12 +18,13 @@ The easiest way to get started is to install via npm.
 
 ## Configuring
 
-There are two ways to configure the plugin, via a JSON file or via `serverless.yml`.
+The plugin can be configured via `serverless.yml`, or alternatively via environment variables.
+
 There are two supported methods for configuring the endpoints, globally via the
 `host` property, or individually. These properties may be mixed, allowing for
 global override support while also override specific endpoints.
 
-A `host` or individual endpoints must be configured or this plugin will be deactivated.
+A `host` or individual endpoints must be configured, or this plugin will be deactivated.
 
 ### Configuration via serverless.yml
 
@@ -59,6 +60,12 @@ custom:
       ...
 ```
 
+### Configuration via environment variables
+
+The following environment variables can be configured (taking precedence over the values in `serverless.yml`):
+* `EDGE_PORT`: LocalStack edge port to connect to (default: `4566`)
+* `LOCALSTACK_HOSTNAME`: LocalStack host name to connect to (default: `localhost`)
+
 ### Activating the plugin for certain stages
 
 Note the `stages` attribute in the config above. The `serverless-localstack` plugin gets activated if either:
@@ -198,6 +205,7 @@ custom:
 
 ## Change Log
 
+* v1.0.1: Add support for Serverless projects with esbuild source config; enable config via environment variables
 * v1.0.0: Allow specifying path for mountCode, to point to a relative Lambda mount path
 * v0.4.36: Add patch to avoid "TypeError" in AwsDeploy plugin on Serverless v3.4.0+
 * v0.4.35: Add config option to connect to additional Docker networks
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "serverless-localstack",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Connect Serverless to LocalStack!",
   "main": "src/index.js",
   "scripts": {
diff --git a/src/index.js b/src/index.js
@@ -536,7 +536,8 @@ class LocalstackPlugin {
   reconfigureAWS() {
     if(this.isActive()) {
       this.log('Using serverless-localstack');
-      const host = this.config.host || 'http://localhost';
+      const hostname = process.env.LOCALSTACK_HOSTNAME || 'localhost';
+      const host = this.config.host || `http://${hostname}`;
       const edgePort = this.getEdgePort();
       const configChanges = {};
 
@@ -645,7 +646,7 @@ class LocalstackPlugin {
   /** Utility functions below **/
 
   getEdgePort() {
-    return this.config.edgePort || DEFAULT_EDGE_PORT;
+    return process.env.EDGE_PORT || this.config.edgePort || DEFAULT_EDGE_PORT;
   }
 
   getAwsProvider() {

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "serverless-localstack",`
`3`		`- "version": "1.0.0",`
	`3`	`+ "version": "1.0.1",`
`4`	`4`	`"description": "Connect Serverless to LocalStack!",`
`5`	`5`	`"main": "src/index.js",`
`6`	`6`	`"scripts": {`