@bsb/base 9.6.3 → 9.6.4
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 +7 -6
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -148,15 +148,15 @@ Multi-stage build produces a minimal runtime image:
|
|
|
148
148
|
- Volumes: `/mnt/plugins` (external plugins), `/mnt/temp`
|
|
149
149
|
- Entrypoint runs `node lib/cli.js` as an unprivileged `node` user
|
|
150
150
|
- Optional plugin install/update at startup:
|
|
151
|
-
- `BSB_PLUGINS="@scope/plugin-a:1.2.3,@scope/plugin-b"` -> installs
|
|
152
|
-
- `BSB_PLUGIN_UPDATE=yes` ->
|
|
151
|
+
- `BSB_PLUGINS="@scope/plugin-a:1.2.3,@scope/plugin-b@2.4.1"` -> installs listed packages
|
|
152
|
+
- `BSB_PLUGIN_UPDATE=yes` -> refreshes installed plugins through the startup installer
|
|
153
153
|
|
|
154
154
|
Example run (with mounted plugins directory):
|
|
155
155
|
```bash
|
|
156
156
|
docker run --rm \
|
|
157
|
-
-e BSB_PLUGINS="@bettercorp/your-plugin" \
|
|
157
|
+
-e BSB_PLUGINS="@bettercorp/your-plugin@1.2.3" \
|
|
158
158
|
-v $(pwd)/plugins:/mnt/plugins \
|
|
159
|
-
betterweb/service-base:
|
|
159
|
+
betterweb/service-base:node
|
|
160
160
|
```
|
|
161
161
|
|
|
162
162
|
Recommended plugin directory layout (when using `BSB_PLUGIN_DIRS`):
|
|
@@ -176,13 +176,14 @@ Recommended plugin directory layout (when using `BSB_PLUGIN_DIRS`):
|
|
|
176
176
|
Notes
|
|
177
177
|
- In container deployments, prefer placing prebuilt plugins under `BSB_PLUGIN_DIRS` as above. This avoids network installs on boot and ensures deterministic versions via immutable versioned folders.
|
|
178
178
|
- `BSB_PLUGINS` is available for dynamic `npm install` at startup, but mounting a curated plugin repository via `BSB_PLUGIN_DIRS` is recommended for production.
|
|
179
|
+
- Avoid unversioned `BSB_PLUGINS` entries and `@latest`; they can cross breaking releases and add network install time to every boot that runs the installer.
|
|
179
180
|
|
|
180
181
|
### Environment Variables
|
|
181
182
|
- `APP_DIR`: Override working directory (mainly used in local development/testing)
|
|
182
183
|
- `BSB_DEBUG`: Enable debug logging in production mode (`true|1|yes|y`). Produces `production-debug` mode.
|
|
183
184
|
- `BSB_PLUGIN_DIRS`: Comma-separated list of external plugin directories (searched in order; first is install target)
|
|
184
185
|
- `BSB_PLUGIN_DIR`: Single external plugin directory (legacy, still supported). Accepts comma-separated paths.
|
|
185
|
-
- `BSB_PLUGINS`: Comma-separated list of npm packages to install at container start (entrypoint.js)
|
|
186
|
+
- `BSB_PLUGINS`: Comma-separated list of npm packages to install at container start (entrypoint.js). Prefer exact versions.
|
|
186
187
|
- `BSB_PLUGIN_UPDATE`: `yes|y|true` to run `npm update` at container start
|
|
187
188
|
- Config plugin override (advanced):
|
|
188
189
|
- `BSB_CONFIG_PLUGIN`: Name of config plugin (must start with `config-`)
|
|
@@ -223,7 +224,7 @@ At minimum, export a `Plugin` class in `lib/plugins/<type>-<name>/index.js` (or
|
|
|
223
224
|
docker run --rm \
|
|
224
225
|
-v $(pwd)/plugins:/mnt/plugins:ro \
|
|
225
226
|
-e BSB_PLUGIN_DIR=/mnt/plugins \
|
|
226
|
-
betterweb/service-base:
|
|
227
|
+
betterweb/service-base:node
|
|
227
228
|
```
|
|
228
229
|
|
|
229
230
|
Local development (for contributors only):
|