@membranehq/cli 1.2.13 → 1.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -2
- package/dist/index.js +101 -98
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -42,7 +42,7 @@ The CLI can be configured using either environment variables or a configuration
|
|
|
42
42
|
```bash
|
|
43
43
|
export MEMBRANE_WORKSPACE_KEY=<your-workspace-key>
|
|
44
44
|
export MEMBRANE_WORKSPACE_SECRET=<your-workspace-secret>
|
|
45
|
-
export MEMBRANE_API_URI=https://api.
|
|
45
|
+
export MEMBRANE_API_URI=https://api.your-membrane-instance.com # Only needed when using a self-hosted version of Membrane. Set to the URL of your hosted membrane instance. Defaults to https://api.getmembrane.com
|
|
46
46
|
export MEMBRANE_TEST_CUSTOMER_ID=<test-customer-id> # Optional: test customer ID for testing integrations
|
|
47
47
|
```
|
|
48
48
|
|
|
@@ -54,12 +54,14 @@ The CLI uses a configuration file at `membrane.config.yml`:
|
|
|
54
54
|
workspaceKey: <your-workspace-key>
|
|
55
55
|
workspaceSecret: <your-workspace-secret>
|
|
56
56
|
# Optional
|
|
57
|
-
apiUri: https://api.
|
|
57
|
+
apiUri: https://api.your-membrane-instance.com # Only needed when using a self-hosted version of Membrane. Set to the URL of your hosted membrane instance. Defaults to https://api.getmembrane.com
|
|
58
58
|
testCustomerId: test-customer # Internal id of the customer to be used for testing integrations.
|
|
59
59
|
```
|
|
60
60
|
|
|
61
61
|
**Note:** When both environment variables and configuration file are present, environment variables take precedence.
|
|
62
62
|
|
|
63
|
+
**Self-Hosting:** For details on self-hosting Membrane, see [Self-Hosting Documentation](https://getmembrane.com/features/self-hosting).
|
|
64
|
+
|
|
63
65
|
## Version Control
|
|
64
66
|
|
|
65
67
|
`membrane.config.yml` contains secrets. You should exclude it from version control.
|