Skip to content

Commit

Permalink
[automated commit] Bump docs to versions 2.22.0, 1.53.4
Browse files Browse the repository at this point in the history
  • Loading branch information
leorossi authored and github-actions[bot] committed Dec 5, 2024
1 parent c678efc commit e57096f
Show file tree
Hide file tree
Showing 189 changed files with 23 additions and 5 deletions.
4 changes: 2 additions & 2 deletions docs/composer/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Configure `@platformatic/composer` specific settings such as `services` or `refr
- `prefix` (`string`) - Service proxy prefix. All service routes will be prefixed with this value.

:::note
If the prefix is not explictly set, the composer and the service will try to find the best prefix for the service.
If the prefix is not explicitly set, the composer and the service will try to find the best prefix for the service.

First of all, if the application code used the `platformatic.setBasePath` (which is always available in each service),
then the value will become the service prefix.
Expand All @@ -68,7 +68,7 @@ Configure `@platformatic/composer` specific settings such as `services` or `refr
}
```

or with the [metaline](https://github.com/platformatic/metaline) syntax, especially in the case of using the [json configuration](/docs/reference/cli.md#start).
or with the [metaline](https://github.com/platformatic/metaline) syntax, especially in the case of using the [json configuration](/docs/cli.md#start).

```json
"defaultArgsAdapter": "where.id.in.$>#id"
Expand Down
9 changes: 9 additions & 0 deletions docs/runtime/_shared-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,11 +67,20 @@ runtime. Each service object supports the following settings:
on `127.0.0.1`, and exposed to the other services via that port, on default it is set to `false`. Set it to `true` if you are using [@fastify/express](https://github.com/fastify/fastify-express).
- **`workers`** (`number`) - The number of workers to start for this service. If the service is the entrypoint or if the runtime is running in development mode this value is ignored and hardcoded to `1`.
- **`health`** (object): Configures the health check for each worker of the service. It supports all the properties also supported in the runtime [health](#health) property. The values specified here overrides the values specified in the runtime.
- **`envfile`** (`string`) - The path to an `.env` file to load for the service.
- **`env`** (`object`) - An object containing environment variables to set for the service. Values set here takes precedence over values set in the `envfile`.

If this property is present, then the services will not be reordered according to the
`getBootstrapDependencies` function and they will be started in the order they are defined in
the configuration file.

### `env`

An object containing environment variables to set for all services in the
runtime. Any environment variables set in the `env` object will be merged with
the environment variables set in the `envfile` and `env` properties of each
service, with service-level environment variables taking precedence.

### `resolvedServicesBasePath`

The base path, relative to the configuration file to store resolved services. Each service will be saved in `{resolvedServicesBasePath}/{id}`. Default: `external`.
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Configure `@platformatic/composer` specific settings such as `services` or `refr
- `prefix` (`string`) - Service proxy prefix. All service routes will be prefixed with this value.

:::note
If the prefix is not explictly set, the composer and the service will try to find the best prefix for the service.
If the prefix is not explicitly set, the composer and the service will try to find the best prefix for the service.

First of all, if the application code used the `platformatic.setBasePath` (which is always available in each service),
then the value will become the service prefix.
Expand All @@ -68,7 +68,7 @@ Configure `@platformatic/composer` specific settings such as `services` or `refr
}
```

or with the [metaline](https://github.com/platformatic/metaline) syntax, especially in the case of using the [json configuration](/docs/reference/cli.md#start).
or with the [metaline](https://github.com/platformatic/metaline) syntax, especially in the case of using the [json configuration](/docs/cli.md#start).

```json
"defaultArgsAdapter": "where.id.in.$>#id"
Expand Down
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -67,11 +67,20 @@ runtime. Each service object supports the following settings:
on `127.0.0.1`, and exposed to the other services via that port, on default it is set to `false`. Set it to `true` if you are using [@fastify/express](https://github.com/fastify/fastify-express).
- **`workers`** (`number`) - The number of workers to start for this service. If the service is the entrypoint or if the runtime is running in development mode this value is ignored and hardcoded to `1`.
- **`health`** (object): Configures the health check for each worker of the service. It supports all the properties also supported in the runtime [health](#health) property. The values specified here overrides the values specified in the runtime.
- **`envfile`** (`string`) - The path to an `.env` file to load for the service.
- **`env`** (`object`) - An object containing environment variables to set for the service. Values set here takes precedence over values set in the `envfile`.

If this property is present, then the services will not be reordered according to the
`getBootstrapDependencies` function and they will be started in the order they are defined in
the configuration file.

### `env`

An object containing environment variables to set for all services in the
runtime. Any environment variables set in the `env` object will be merged with
the environment variables set in the `envfile` and `env` properties of each
service, with service-level environment variables taking precedence.

### `resolvedServicesBasePath`

The base path, relative to the configuration file to store resolved services. Each service will be saved in `{resolvedServicesBasePath}/{id}`. Default: `external`.
Expand Down
2 changes: 1 addition & 1 deletion versions.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[
"2.21.1",
"2.22.0",
"1.53.4"
]

0 comments on commit e57096f

Please sign in to comment.