--- title: "Runtime configuration" description: "Dynamically adjust collaboration settings in your document server with straightforward API calls. Adjust secrets, webhook URLs, and more." canonical_url: "https://tiptap.dev/docs/collaboration/operations/configure" --- # Runtime configuration Dynamically adjust collaboration settings in your document server with straightforward API calls. Adjust secrets, webhook URLs, and more. Configure runtime settings in your document server to manage your environment directly via the REST API. These settings let you modify secrets, webhook URLs, and more, particularly when adapting to changes in your project requirements or security protocols, without restarting your application. ## Settings overview Several settings can be adjusted dynamically: | Key | Description | | ---------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `secret` | [JWT secret](https://tiptap.dev/docs/collaboration/getting-started/authenticate.md), auto-generated on the first launch | | `api_secret` | API secret to use in the Authorization header, auto-generated on the first launch | | `allowed_origins` | Validates `Origin` headers against the provided values (comma separated), e.g., `https://test.tiptap.dev,https://*.tiptap.dev`; If not set, validation is disabled | | `authentication_disabled` | Set to `1` to disable authentication, `0` to enable (default: `0`) | | `webhook_url` | URL for receiving webhook callbacks | | `webhook_loader_url` | Optional webhook URL for initially loading documents. See [webhooks](https://tiptap.dev/docs/collaboration/core-concepts/webhooks.md#loader-webhook) for more information. | | `webhook_version` | Version of the webhook | | `webhook_awareness` | Enable awareness webhooks for user activity, tracking `user.connected` and `user.disconnected` events (`1` for enabled, `0` for disabled) | | `webhook_log_errors_only` | Log only webhook errors; successful webhook logs are disabled | | `default_auto_versioning` | Set to `1` to enable auto versioning, `0` to disable (default: `0`) | | `default_auto_versioning_interval` | Interval for auto versioning in seconds (default: `30` seconds) | | `auto_versioning_all_fragments` | Set to `1` to make versioning listen for changes on any fragment/field of the doc (default is `0`, which will just watch the `default` fragment). This both affects auto versioning and manual versioning ; manual versioning will require `force=true` when this setting is `0`. Changing this requires the server to re-load the document to come into effect. | | `jwt_explicit_access` | Set to `1` to prevent document access when no "allowedDocumentNames" is set in the JWT. | | `skip_s3_health_check` | Set to `1` to turn off the s3 health check (on-prem only). This is useful if your s3 storage does not support `getCalledIdentity`. | | `name` | Instance name for identification | | `webhook_include_ydoc_state` | Set this to `1` to include the full yjs document in all document.saved webhooks | | `thread_authenticator` | Set this to `1` to enable the thread authenticator. Threads/comments will automatically be assigned with the user id from the JWT, and it will not be possible to edit or delete foreign threads. However, foreign threads can usually be resolved (except if disabled using the setting below) | | `commentonly_disallow_resolve_foreign_threads` | Set this to `1` to disallow resolving foreign threads when on comment-only connections. | | `webhook_include_fields` | Set this to `1` to include custom yjs fields in the webhook (see [webhooks](https://tiptap.dev/docs/collaboration/core-concepts/webhooks.md#custom-fields)). | ## Managing settings via API The collaboration platform offers a straightforward API for managing these settings. Replace `:key` with the setting key you wish to update and `YOUR_APP_ID` with your document server ID (labeled "Document server ID" in the [Cloud dashboard](https://cloud.tiptap.dev/v2/configuration/document-server)). ### Create or overwrite settings Use this call to add or update settings: ```bash curl --location --request PUT 'https://YOUR_APP_ID.collab.tiptap.cloud/api/admin/settings/:key' \ --header 'Authorization: YOUR_SECRET_FROM_SETTINGS_AREA' --header 'Content-Type: text/plain' \ -d 'your value' ``` ### List current settings Use this call to retrieve a list of all current settings: ```bash curl --location 'https://YOUR_APP_ID.collab.tiptap.cloud/api/admin/settings' \ --header 'Authorization: YOUR_SECRET_FROM_SETTINGS_AREA' ``` ### Retrieve a specific setting Use this call to retrieve the value of a particular setting: ```bash curl --location 'https://YOUR_APP_ID.collab.tiptap.cloud/api/admin/settings/:key' \ --header 'Authorization: YOUR_SECRET_FROM_SETTINGS_AREA' ``` ### Delete a setting Use this call to delete a setting: ```bash curl --location --request DELETE 'https://YOUR_APP_ID.collab.tiptap.cloud/api/admin/settings/:key' \ --header 'Authorization: YOUR_SECRET_FROM_SETTINGS_AREA' ``` ## Server performance metrics Use the `/api/statistics` endpoint to gather server performance data, including total document count, peak concurrent connections, total connections over the last 30 days, and lifetime connection counts. Review the [metrics](https://tiptap.dev/docs/collaboration/operations/metrics.md) page for additional information. ```bash curl --location 'https://YOUR_APP_ID.collab.tiptap.cloud/api/statistics' \ --header 'Authorization: YOUR_SECRET_FROM_SETTINGS_AREA' ```