Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# Link Placeholders for Configuration

## reference_versioned_docs/version-v4/configuration/options.md

- Line (http.mtls section): `[mTLS Authentication](TODO:reference_versioned_docs/version-v4/security/mtls-authentication.md)`
- Context: Referencing full mTLS authentication reference from HTTP mTLS config sub-section
- Target should be: `../security/mtls-authentication.md`

- Line (http.mtls.certificateVerification): `[Certificate Verification](TODO:reference_versioned_docs/version-v4/security/certificate-verification.md)`
- Context: Referencing certificate revocation checking (CRL/OCSP) documentation
- Target should be: `../security/certificate-verification.md`

- Line (tls section): `[TLS](TODO:reference_versioned_docs/version-v4/http/tls.md)`
- Context: Linking to TLS configuration reference in the HTTP section
- Target should be: `../http/tls.md`

- Line (tls section): `[Certificate Management](TODO:reference_versioned_docs/version-v4/security/certificate-management.md)`
- Context: Linking to certificate management operations
- Target should be: `../security/certificate-management.md`

- Line (mqtt section): `[MQTT Configuration](TODO:reference_versioned_docs/version-v4/mqtt/configuration.md)`
- Context: Referencing full MQTT configuration reference
- Target should be: `../mqtt/configuration.md`

- Line (logging section): `[logger API](TODO:reference_versioned_docs/version-v4/logging/api.md)`
- Context: `logging.external` section referencing the logger API for components
- Target should be: `../logging/api.md`

- Line (replication section): `[Replication](TODO:reference_versioned_docs/version-v4/replication/overview.md)`
- Context: Referencing replication overview from replication config section
- Target should be: `../replication/overview.md`

- Line (replication section): `[Clustering](TODO:reference_versioned_docs/version-v4/replication/clustering.md)`
- Context: Referencing clustering reference from replication config section
- Target should be: `../replication/clustering.md`

- Line (replication.shard): `[Sharding](TODO:reference_versioned_docs/version-v4/replication/sharding.md)`
- Context: Referencing sharding documentation for `replication.shard` config option
- Target should be: `../replication/sharding.md`

- Line (storage.compactOnStart): `[Compaction](TODO:reference_versioned_docs/version-v4/database/compaction.md)`
- Context: Referencing compaction documentation from `compactOnStart` storage option
- Target should be: `../database/compaction.md`

- Line (localStudio section): `[Studio](TODO:reference_versioned_docs/version-v4/studio/overview.md)`
- Context: Referencing Studio overview from `localStudio` config section
- Target should be: `../studio/overview.md`

- Line (Components section): `[Components](TODO:reference_versioned_docs/version-v4/components/overview.md)`
- Context: Referencing components overview from component config section
- Target should be: `../components/overview.md`

## reference_versioned_docs/version-v4/configuration/operations.md

- Line (set_configuration description): `[restart](TODO:reference_versioned_docs/version-v4/operations-api/operations.md#restart)`
- Context: Linking to the restart system operation needed after set_configuration
- Target should be: `../operations-api/operations.md#restart`

- Line (set_configuration description): `[restart_service](TODO:reference_versioned_docs/version-v4/operations-api/operations.md#restart-service)`
- Context: Linking to the restart_service operation needed after set_configuration
- Target should be: `../operations-api/operations.md#restart-service`
141 changes: 141 additions & 0 deletions reference_versioned_docs/version-v4/configuration/operations.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,141 @@
---
title: Configuration Operations
---

<!-- Source: versioned_docs/version-4.7/developers/operations-api/configuration.md (primary) -->

# Configuration Operations

Operations API endpoints for reading and modifying Harper configuration.

_All operations in this section are restricted to `super_user` roles._

For the full list of configurable options, see [Configuration Options](./options.md).

---

## Set Configuration

Modifies one or more Harper configuration parameters. **Requires a [restart](TODO:reference_versioned_docs/version-v4/operations-api/operations.md#restart 'restart operation') or [restart_service](TODO:reference_versioned_docs/version-v4/operations-api/operations.md#restart-service 'restart_service operation') to take effect.**

`operation` _(required)_ — must be `set_configuration`

Additional properties correspond to configuration keys in underscore-separated format (e.g. `logging_level` for `logging.level`, `clustering_enabled` for `clustering.enabled`).

### Body

```json
{
"operation": "set_configuration",
"logging_level": "trace",
"clustering_enabled": true
}
```

### Response: 200

```json
{
"message": "Configuration successfully set. You must restart HarperDB for new config settings to take effect."
}
```

---

## Get Configuration

Returns the current Harper configuration.

`operation` _(required)_ — must be `get_configuration`

### Body

```json
{
"operation": "get_configuration"
}
```

### Response: 200

```json
{
"http": {
"compressionThreshold": 1200,
"cors": false,
"corsAccessList": [null],
"keepAliveTimeout": 30000,
"port": 9926,
"securePort": null,
"timeout": 120000
},
"threads": 11,
"authentication": {
"cacheTTL": 30000,
"enableSessions": true,
"operationTokenTimeout": "1d",
"refreshTokenTimeout": "30d"
},
"analytics": {
"aggregatePeriod": 60
},
"replication": {
"hostname": "node1",
"databases": "*",
"routes": null,
"url": "wss://127.0.0.1:9925"
},
"componentsRoot": "/Users/hdb/components",
"localStudio": {
"enabled": false
},
"logging": {
"auditAuthEvents": {
"logFailed": false,
"logSuccessful": false
},
"auditLog": true,
"auditRetention": "3d",
"file": true,
"level": "error",
"root": "/Users/hdb/log",
"rotation": {
"enabled": false,
"compress": false,
"interval": null,
"maxSize": null,
"path": "/Users/hdb/log"
},
"stdStreams": false
},
"mqtt": {
"network": {
"port": 1883,
"securePort": 8883
},
"webSocket": true,
"requireAuthentication": true
},
"operationsApi": {
"network": {
"cors": true,
"corsAccessList": ["*"],
"domainSocket": "/Users/hdb/operations-server",
"port": 9925,
"securePort": null
}
},
"rootPath": "/Users/hdb",
"storage": {
"writeAsync": false,
"caching": true,
"compression": false,
"noReadAhead": true,
"path": "/Users/hdb/database",
"prefetchWrites": true
},
"tls": {
"privateKey": "/Users/hdb/keys/privateKey.pem"
}
}
```
Loading
Loading