Configuration

Storage

The "storage" section is how AltFinder stores long-term data. Let's break the section down.

storage:

The "method" is how the data will be stored. The current storage methods are outlined here.

  method: 'sqlite'

The "data" section gives a way to connect to a remote database and defines how the data is organized. You may specify a remote database address, username, password, whether or not to use SSL, and in the case of MongoDB the connection prefix and uri.

You may also specify the database name (which in the case of remote databases will need to be created first) and table prefix (in case you want to use a "global" database.)

  data:
    address: '127.0.0.1:3306'
    database: 'altfinder'
    prefix: 'altfinder_'
    username: ''
    password: ''
    ssl: false

    mongodb:
      collection-prefix: ''
      connection-uri: ''

The "settings" section allows setting the number of connections in the pool and various connection timeout, lifetime, and encoding settings.

The "max-pool-size" is the maximum number of connections the plugin will make to a given database. The "min-idle" is the minimum number of connections the plugin will keepalive after non-use. It's generally good practice to keep these two numbers the same.

The "max-lifetime" is how long a connection will live for before being re-created, and "timeout" is how long the plugin will wait before giving up on a new connection. Generally, you won't need to touch these, but if your database setup is different then you may want to have a second look.

Similarly, the "properties" section defines what encoding to use and whether or not to use Unicode. Generally, you won't need to change these, but they're here if you do.

  settings:
    max-pool-size: 2
    min-idle: 2
    max-lifetime: 1800000 # 30 minutes
    timeout: 5000 # 5 seconds

    properties:
      unicode: true
      encoding: 'utf8'

Redis/RabbitMQ

The "Redis" and "RabbitMQ" sections allow you to connect to an existing Redis or RabbitMQ installation so they may be used for cache storage or to push instant updates across servers.

If you use Redis, set "enabled" here to true and fill in the address (+port, if needed) and password (if needed) for the Redis installation.

redis:
  enabled: false
  address: '127.0.0.1:6379'
  password: ''

If you use RabbitMQ, set "enabled" here to true and fill in the address (+port, if needed) and username/password for the Rabbit installation.

rabbitmq:
  enabled: false
  address: '127.0.0.1:5672'
  username: 'guest'
  password: 'guest'

The "ignore" list is a list of IPs or UUIDs to ignore when deciding to store players. This will skip storage for any player that connects from any IP defined here, or from any player defined here.

  ignore:
  - '127.0.0.1'
  - 'localhost'
  - '::1'
#  - '069a79f4-44e9-4726-a5be-fca90e38aaf5' #Notch

General

These are some general/misc options that you may or may not want to play with.

Enabling "debug" will tell the plugin to print a LOT more information about its actions to the console. This is very useful when debugging the plugin or trying to figure out why you're getting a particular result from a particular player.

debug: false

This section defines whether or not the plugin will send usage and error stats to the author. Usage stats are provided to bstats and error reports are sent to GameAnalytics.

stats:
  usage: true
  errors: true

This section defines whether or not the plugin checks for updates, and whether or not players with the "altfinder.admin" permission node are notified of updates on login.

update:
  check: true
  notify: true