Skip to content
This repository has been archived by the owner on Sep 12, 2024. It is now read-only.

Configuration Guide v1

Johannes Donath edited this page Jul 7, 2018 · 1 revision

Server Configuration

server.address

Type: IP Address
Default: 0.0.0.0

Configures the address the server is going to bind to.

server.port

Type: Number
Default: 8080

Specifies the port the server is going to bind to.

server.contextPath

Type: String
Default: /

Specifies a prefix which is prepended to all endpoints.

Cache Configuration

cache.aggressiveness

Type: Cache Aggressiveness
Default: high

Specifies the cache's aggressiveness as follows:

Aggressiveness Behavior
low All requests are forwarded to the Mojang API unless an error is reported or the rate limit is reached
moderate Relies on the user's custom time-to-live (TTL) configuration
high Ensures all objects are cached for the longest time possible (e.g. names expire after 37 days, properties and profiles never expire

cache.ttl.profile

Type: Period (in seconds)
Default: -1 (no expiration)

Specifies the maximum time-to-live for profile objects.

cache.ttl.name

Type: Period (in seconds)
Default: 7200 (2 hours)

Specifies the maximum time-to-live for display names.

cache.ttl.property

Type: Period (in seconds)
Default: 3600 (1 hour)

Specifies the maximum time-to-live for display names. Currently the only property provided by the API is the player's skin texture.

Data Source Configuration

spring.datasource.url

Type: JDBC URI
Default: jdbc:h2:./cache

Specifies the database type, hostname, port and database name.

Embedded Example: jdbc:h2:./path/to/database/file PostgreSQL Example: jdbc:postgresql://localhost:1234/stockpile

spring.datasource.username & spring.datasource.password

Type: String
Default: stockpile:1234

Specifies the authentication credentials for the backing database server.

Note: These credentials are also used to encrypt database files created by the embedded database implementation.

spring.jpa.generate-ddl

Type: Boolean
Default: true

Enables or disables automatic database schema creation.

spring.jpa.ddl-auto

Type: Scheme Generation Mode
Default: update

Specifies the method used to verify and update existing databases.

Mode Behavior
none Disables database validation and updating.
validate Ensures the database layout is compatible with the current application version.
update Attempts to alter the database to be used with the current application version.
create Clears all existing data within the database and creates an entirely new schema.
create-drop Clears all existing data within the database, creates an entirely new schema and deletes all data when shut down gracefully.