Hanzo
PlatformHanzo KMSSelf-HostingDeployment OptionsNativeLinux Package

Configurations

Learn how to configure and manage the Hanzo KMS Linux package

Configuration Overview

All configuration for the Hanzo 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.

After making any changes to the kms.rb file, always run kms-ctl reconfigure to apply them.

Example Configuration

# 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.

All kms-ctl Commands

The Hanzo KMS Linux package includes the kms-ctl command-line tool, which allows you to manage your deployment. The available commands are listed below.

CommandDescription
kms-ctl reconfigureApplies changes from kms.rb and restarts the Hanzo KMS services.
kms-ctl startStarts the Hanzo KMS services.
kms-ctl stopStops all running Hanzo KMS services.
kms-ctl statusDisplays the current status of the Hanzo KMS services.
kms-ctl tailStreams real-time logs from the Hanzo KMS application.

How is this guide?

Last updated on

On this page