Skip to content

Commit

Permalink
Updating README with revised parameters from values.yaml of Helm Chart.
Browse files Browse the repository at this point in the history
  • Loading branch information
CI committed Jan 15, 2025
1 parent 255c085 commit 44427ab
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,7 @@ Defines parameters related to connections to the Postgres database.
| `db.PGSSLMODE` | This defines the level of security used when connecting to the Postgres database | `require` |
| `db.connectionAcquisitionTimeoutMillis` | The maximum time in milliseconds to wait for a connection to be acquired from the connection pool. | `15000` |
| `db.connectionCreationTimeoutMillis` | The maximum time in milliseconds to wait for a new connection to be created in the connection pool. Should be less than the acquisition timeout, as a new connection may need to be created then acquired. | `5000` |
| `db.knexAsyncStackTracesEnabled` | If enabled, will provide better stack traces for errors arising out of knex operations | `false` |
| `db.databaseName` | (Optional) The name of the Postgres database to which Speckle will connect. Only required for the Database Monitoring utility when the connection string is to a database connection pool and multi-region is disabled, otherwise this value is ignored. | `""` |
| `db.connectionString.secretName` | Required. A secret containing the full connection string to the Postgres database (e.g. in format of `protocol://username:password@host:port/database`) stored within the Kubernetes cluster as an opaque Kubernetes Secret. Ref: https://kubernetes.io/docs/concepts/configuration/secret/#opaque-secrets | `""` |
| `db.connectionString.secretKey` | Required. The key within the Kubernetes Secret holding the connection string. | `""` |
Expand Down Expand Up @@ -272,6 +273,7 @@ Defines parameters related to the backend server component of Speckle.
| `server.max_object_upload_file_size_mb` | Objects are batched together and uploaded to the /objects endpoint as http POST form data. This determines the maximum size of that form data which can be uploaded to the server. It should be greater than or equal to max_object_size_mb. | `100` |
| `server.max_project_models_per_page` | The maximum number of models that can be returned in a single page of a query for all models of a project | `500` |
| `server.speckleAutomateUrl` | The url of the Speckle Automate instance | `https://automate.speckle.systems` |
| `server.asyncRequestContextEnabled` | If enabled, the server will use the async request context for improved log msg correlation | `false` |
| `server.gendoAI.apiUrl` | The url of the Gendo AI application, including protocol. | `https://api.gendo.ai/external/generate` |
| `server.gendoAI.creditLimit` | The number of Gendo AI credit a user gets every month. | `40` |
| `server.gendoAI.key.secretName` | The name of the Kubernetes Secret containing the Gendo AI key. If left blank, will default to the `secretName` parameter. | `""` |
Expand Down

0 comments on commit 44427ab

Please sign in to comment.