Skip to content

Commit

Permalink
chore: Remove outdated references to workerOptions
Browse files Browse the repository at this point in the history
  • Loading branch information
michaelbromley committed Mar 9, 2021
1 parent c8b2537 commit 31ba228
Show file tree
Hide file tree
Showing 4 changed files with 0 additions and 76 deletions.
18 changes: 0 additions & 18 deletions docs/content/docs/developer-guide/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,21 +152,3 @@ export const config: VendureConfig = {
// ...
}
```

### Connecting to the worker

The Vendure worker is configured with [`VendureConfig.workerOptions`]. The worker is a [Nestjs microservice](https://docs.nestjs.com/microservices/basics) which runs in another process (and can be located on another server or in another container) from the main server.

By default, the worker communication happens over TCP. If you want to run the worker in a separate container or physical server to the server, please see the [deployment guide]({{< relref "deployment" >}}#deploying-the-worker).

```TypeScript
export const config: VendureConfig = {
workerOptions: {
options: {
host: 'localhost',
port: 3020,
},
},
// ...
}
```
49 changes: 0 additions & 49 deletions docs/content/docs/developer-guide/deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,55 +65,6 @@ REQUEST: GET http://localhost:3000/health

Health checks are built on the [Nestjs Terminus module](https://docs.nestjs.com/recipes/terminus). You can also add your own health checks by creating plugins that make use of the [HealthCheckRegistryService]({{< relref "health-check-registry-service" >}}).

## Deploying the worker

By default the worker and server communicate over TCP (other protocols can be used - see the [Nestjs microservices docs](https://docs.nestjs.com/microservices/basics)). In production, you may wish to run the worker in a separate container or machine than the Vendure server. In this case, the `VendureConfig.workerOptions` that get passed to `bootstrap()` and `bootstrapWorker()` will need to be different:

#### Example Scenario

* The Vendure server and worker will run on separate web servers (or in separate containers)
* These servers are behind a reverse proxy, e.g. nginx
* Only the Vendure server machine should be accessible from the internet - nginx is configured to forward requests to port 443 (https traffic) to the Vendure server which is listening on port 3000.

```TypeScript
// vendure-config.ts

export const config: VendureConfig = {
apiOptions: {
hostname: 'localhost',
port: 3000,
},
workerOptions: {
options: {
host: '<IP address of the worker server>',
port: 3020,
},
},
// ...
}
```

```TypeScript
// index.ts

bootstrap(config);
```

```TypeScript
// index-worker.ts

const workerConfig = {
...config,
workerOptions: {
options: {
host: 'localhost',
port: 3020,
},
},
};
bootstrapWorker(workerConfig);
```

## Admin UI

If you have customized the Admin UI with extensions, it can make sense to [compile your extensions ahead-of-time as part of the deployment process]({{< relref "/docs/plugins/extending-the-admin-ui" >}}#compiling-as-a-deployment-step).
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,6 @@ describe('AssetServerPlugin', () => {
apiOptions: {
port: 5050,
},
workerOptions: {
options: {
port: 5055,
},
},
logger: new DefaultLogger({ level: LogLevel.Info }),
plugins: [
AssetServerPlugin.init({
Expand Down
4 changes: 0 additions & 4 deletions packages/dev-server/load-testing/load-test-config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -55,15 +55,11 @@ export function getLoadTestConfig(tokenMethod: 'cookie' | 'bearer'): Required<Ve
importExportOptions: {
importAssetsDir: path.join(__dirname, './data-sources'),
},
workerOptions: {
runInMainProcess: true,
},
customFields: {},
plugins: [
AssetServerPlugin.init({
assetUploadDir: path.join(__dirname, 'static/assets'),
route: 'assets',
port: 5002,
}),
DefaultSearchPlugin,
],
Expand Down

0 comments on commit 31ba228

Please sign in to comment.