Configuration

Configuration Reference

This document describes all configuration options available in HomeManager's config.yml.

Full Configuration Example

# HomeManager configuration file

# Use PostgreSQL database
postgres:
  # Set to true to use PostgreSQL, or else use SQLite
  enabled: false
  # PostgreSQL connection settings
  host: "localhost"
  port: 5432
  database: "home_manager"
  username: "postgres"
  # CHANGE THIS
  password: ""

# Number of homes to display per page in the /home list command
page-size: 5

Configuration Options

postgres.enabled

Attribute	Value
Type	Boolean
Default	false
Description	Set to true to use PostgreSQL, or false for SQLite

When disabled, the plugin uses SQLite (stored in plugins/HomeManager/homes.db).

postgres.host

Attribute	Value
Type	String
Default	"localhost"
Description	PostgreSQL server hostname or IP address

postgres.port

Attribute	Value
Type	Integer
Default	5432
Description	PostgreSQL server port

postgres.database

Attribute	Value
Type	String
Default	"home_manager"
Description	Name of the PostgreSQL database

postgres.username

Attribute	Value
Type	String
Default	"postgres"
Description	PostgreSQL username

postgres.password

Attribute	Value
Type	String
Default	""
Description	PostgreSQL password

Important: Change this to a secure password in production.

page-size

Attribute	Value
Type	Integer
Default	5
Description	Number of homes displayed per page in /home list

Database Locations

SQLite

When using SQLite (default), the database file is located at:

plugins/HomeManager/homes.db

PostgreSQL

When using PostgreSQL, the plugin creates a table named homes in the specified database. See Codebase for the schema.

Reloading Configuration

To reload the configuration:

1. Stop the server
2. Edit plugins/HomeManager/config.yml
3. Restart the server

The plugin does not support runtime configuration reload.