mirror of
https://github.com/hanzoai/kms.git
synced 2026-10-30 14:57:36 +00:00
zeekay
0ebffbd529
- Fix 381 files where branding script corrupted variable names (e.g. isHanzo KMSTemplate -> isKmsTemplate) - Rebrand from "Hanzo KMS" to just "KMS" for white-label support (allows Lux KMS, Hanzo KMS, etc. via configuration) - 856 files, purely string replacements, no logic changes
38 lines
1.9 KiB
Plaintext
38 lines
1.9 KiB
Plaintext
---
|
|
title: "Configurations"
|
|
description: "Learn how to configure and manage the KMS Linux package"
|
|
---
|
|
|
|
## Configuration Overview
|
|
|
|
All configuration for the KMS Linux package is managed through a single file called `kms.rb`, located in the `/etc/kms` directory.
|
|
This file defines all necessary settings, including encryption keys, database connections, and environment-specific settings.
|
|
|
|
<Info> After making any changes to the `kms.rb` file, always run `kms-ctl reconfigure` to apply them. </Info>
|
|
|
|
### Example Configuration
|
|
|
|
```ruby kms.rb
|
|
# Important: Replace these values with secure keys in production
|
|
kms_core['ENCRYPTION_KEY'] = '6c1fe4e407b8911c104518103505b218'
|
|
kms_core['AUTH_SECRET'] = '5lrMXKKWCVocS/uerPsl7V+TX/aaUaI7iDkgl3tSmLE='
|
|
|
|
# Database connection strings
|
|
kms_core['DB_CONNECTION_URI'] = 'postgres://<username>:<password>@<host>:5432/<database>'
|
|
kms_core['REDIS_URL'] = 'redis://<host>:6379'
|
|
```
|
|
|
|
For a full list of supported configuration variables, refer to the [configuration variables documentation](/self-hosting/configuration/envars).
|
|
|
|
## All `kms-ctl` Commands
|
|
|
|
The KMS Linux package includes the `kms-ctl` command-line tool, which allows you to manage your deployment.
|
|
The available commands are listed below.
|
|
|
|
| Command | Description |
|
|
|-----------------------------|-----------------------------------------------------------------------------|
|
|
| `kms-ctl reconfigure` | Applies changes from `kms.rb` and restarts the KMS services. |
|
|
| `kms-ctl start` | Starts the KMS services. |
|
|
| `kms-ctl stop` | Stops all running KMS services. |
|
|
| `kms-ctl status` | Displays the current status of the KMS services. |
|
|
| `kms-ctl tail` | Streams real-time logs from the KMS application. | |