Skip to content
This repository has been archived by the owner on Aug 26, 2022. It is now read-only.

Configuration

Dqu1J edited this page Nov 12, 2021 · 8 revisions

Configuration

The configuration file for the SimplerAuth is located in the config folder, and is called simplerauth-config.json.

Below, you will see the descriptions of all the options in that config file.


version

Do not touch that, if you do, that will break your configuration!


language

Default value: en_us
Change mod language to one of the supported languages
Supported languages:

Code Language Name
en_us English (US) American English
ru_ru Русский Russian
es_es Español (España) Spanish
de_de Deutsch German
cs_cz Čeština (Česká Republika) Czech
uk_ua Українська Ukrainian

Don't see your language here? Help us add it by creating a pull request!


sessions-enabled

Default value: true
Specifies if session feature is enabled.


sessions-valid-hours

Default value: 6
Specifies the duration in hours of how long sessions are valid.


username-regex

Default value: ^[A-z0-9_]{3,16}$
Sets the valid username regex.
Only users with usernames which match that regex will be able to join.
Set to ^.+$ to disable.


skip-online-auth

Default value: true
If enabled, players that are authenticated with Mojang or Microsoft account will skip the authentication.
Works in both online and offline mode servers.


password-type

Default value: local
Specifies the password type that is set on the server.

If set to local, every player will have their own password, and will have to registrate.
If set to global, every player will have to enter the global password, that is set in global-password config parameter.


global-password

Default value: 123456
Specifies the global password for all the players.
That option is only active when password-type is set to global.


forced-online-auth

Default value: false
When enabled, all the users with the username of a valid Minecraft account will use online authentication.


optional-online-auth

Default value: true
Enables the onlineauth command


forced-offline-users

Default value: []
Sets the users who are forced to use default authentication, even if online authentication is enabled for them.
Example: ["user1", "user2"]


require-auth-permission-level

Default value: 0
Sets the minimum permission level required for requiring authentication.
Can be used to enable authentication only for administrators.
What are permission levels? See this page on Minecraft Wiki.


prevent-logging-another-location

Default value: true
Prevents a player joining the server, if that player is already present on the server.
Prevents Logged in from another location


password-regex

Default value: ^.{6,}$
Sets the valid password regex when registering.
Only affects local authentication type.
Set to ^.+$ to disable.


hide-position

Default value: false
When enabled, players position will be hidden before auth.


optional-2fa

Enables optional 2FA


portal-teleport

When enabled, if the player logged in in the portal blocks, SimplerAuth will try to teleport the player away to the nearest safe location. Ignored when position-hiding is enabled.