AuthMeReloaded/src/main/resources/config.yml

349 lines
14 KiB
YAML
Raw Normal View History

2013-03-09 03:42:17 +01:00
DataSource:
# Column for storing or checking players nickname
2013-03-09 03:42:17 +01:00
mySQLColumnName: username
# Table of the database
2013-03-09 03:42:17 +01:00
mySQLTablename: authme
# Username about Database Connection Infos
2013-03-09 03:42:17 +01:00
mySQLUsername: authme
# Can be set to : file, sqlite, mysql
2013-03-09 03:42:17 +01:00
backend: file
# Column for storing players lastlogins
2013-03-09 03:42:17 +01:00
mySQLColumnLastLogin: lastlogin
# Database Name, use with converters or as SQLITE database name
2013-03-09 03:42:17 +01:00
mySQLDatabase: authme
# Database Port
2013-03-09 03:42:17 +01:00
mySQLPort: '3306'
# Column for storing players IPs
2013-03-09 03:42:17 +01:00
mySQLColumnIp: ip
# Database location
2013-03-09 03:42:17 +01:00
mySQLHost: 127.0.0.1
# Column for storing players passwords
2013-03-09 03:42:17 +01:00
mySQLColumnPassword: password
# Password about Database Connection Infos
2013-03-09 03:42:17 +01:00
mySQLPassword: '12345'
# Do we need to cache all things ? Not Recommanded with multiThreading enable
2013-03-09 03:42:17 +01:00
caching: true
# Column for SaveQuitLocation - X
2013-03-09 03:42:17 +01:00
mySQLlastlocX: x
# Column for SaveQuitLocation - Y
mySQLlastlocY: y
# Column for SaveQuitLocation - Z
mySQLlastlocZ: z
# Column for SaveQuitLocation - World name
mySQLlastlocWorld: world
# Column for storing players emails
2013-03-09 03:42:17 +01:00
mySQLColumnEmail: email
# Column of IDs to sort data
2013-03-09 03:42:17 +01:00
mySQLColumnId: id
GroupOptions:
# if you want to set up a particulary Permission Group for
# users that arent registered yet. Pay attention this option
# is casesensitive!
# Example: UnregisteredPlayerGroup: GuestUser
2013-03-09 03:42:17 +01:00
UnregisteredPlayerGroup: ''
# Same as UnregisteredGroup if u want to set a switch
# between unregistered and registered player group
# set the group name below
2013-03-09 03:42:17 +01:00
RegisteredPlayerGroup: ''
# with this option you can add specified permission onJoin
# like for example LoginBonus from another plugins, AuthMe
# will check onJoin if player has that permissions in his Group
# if true it add a temporany permissions to that user. This Field
# is needed beacuse AuthMe switch all unlogged players on a
# specified restricted Permission Group, so plugins that will use
# some particolary permissions on join doesnt work, without
# compiling option below!
2013-03-09 03:42:17 +01:00
Permissions:
PermissionsOnJoin: []
settings:
sessions:
# Do you want to enable session? When enabled
# the ip of a player will be bound to the nickname
# of the player on login. As long as neither of those
# two change players don't have to login on a reconnect
2013-03-09 03:42:17 +01:00
enabled: false
# After how many minutes a session should timeout?
# 0 for unlimitted sessions, use 0 at your own risk!
# consider that session will end only after timeout, and
# if player's ip is changed but the timeout treshould isent
# ended, player will kick out of sever for unvalidSession!
2013-03-09 03:42:17 +01:00
timeout: 10
# Do we need to timeout the session if the player is offline
# And try to login with an another IP Address?
2013-03-12 17:20:33 +01:00
sessionExpireOnIpChange: false
2013-03-09 03:42:17 +01:00
restrictions:
# Can unregistered players chat, care , that block all commands except followers
2013-03-09 03:42:17 +01:00
allowChat: false
# Commands allowed when a player is unlogged
2013-03-09 03:42:17 +01:00
allowCommands:
- /login
- /register
- /l
- /reg
- /passpartu
- /email
- /captcha
# Maximum Registraion per IP default: 1
2013-03-09 03:42:17 +01:00
maxRegPerIp: 1
# max allowed nick length (Warning when you use
# mysql and choose a value >20 you have to
# increase the size of the nickname column in your
# mysql table)
2013-03-09 03:42:17 +01:00
maxNicknameLength: 20
# Player that is online arent
# kick out for "logged in from another
# Location", this options will prevent players that would exploit
# your account when you are playing
2013-03-09 03:42:17 +01:00
ForceSingleSession: true
# Teleport every time player join at World Spawn location,
# even if they loggedin successfully,
# all quit and previus location will
# overwrite with World Spawn. Different From
# "teleportUnAuthedToSpawn"
# that teleport player back to his quit or kick position,
# when he loggedin
2013-03-09 03:42:17 +01:00
ForceSpawnLocOnJoinEnabled: false
# This will prevent all lost of quit position, when player
# isent loggedin
2013-03-09 03:42:17 +01:00
SaveQuitLocation: false
# For activate Restricted user by ip u need
# to set True this option and configure the field
# AllowedRestrctedUser as show below
2013-03-09 03:42:17 +01:00
AllowRestrictedUser: false
# Restricted user will kick players that
# is listed below and they dont
# meet the match of username;ip
# Example playername;127.0.0.1 , if playername
# hasent 127.0.0.1 as ip address
# he will not be allowed to join the server
AllowedRestrictedUser:
- playername;127.0.0.1
# Should unregistered players be kicked immediatly?
2013-03-09 03:42:17 +01:00
kickNonRegistered: false
# Should fail password players be kicked immediatly?
2013-03-09 03:42:17 +01:00
kickOnWrongPassword: false
# should not loged in players be teleported to spawn?
# On login they will be teleported back to their normal
# position
2013-03-09 03:42:17 +01:00
teleportUnAuthedToSpawn: false
# min allowed nick length
2013-03-09 03:42:17 +01:00
minNicknameLength: 3
# Can unregistered players walk around?
2013-03-09 03:42:17 +01:00
allowMovement: false
# After what time players who fail to login or register
# should be kicked. Set to 0 to disable.
2013-03-09 03:42:17 +01:00
timeout: 30
# Regex sintax for allowed Char in player name.
2013-03-09 03:42:17 +01:00
allowedNicknameCharacters: '[a-zA-Z0-9_?]*'
# How far can unregistered players walk? Set to 0
# for unlimited radius
2013-03-09 03:42:17 +01:00
allowedMovementRadius: 100
# Enable double check of password when you register
# when it's true, registration require that kind of command:
# /register <password> <confirmPassword>
2013-03-09 03:42:17 +01:00
enablePasswordVerifier: true
# Should we protect the player inventory before logging in?
2013-03-09 03:42:17 +01:00
ProtectInventoryBeforeLogIn: true
# Should we display all other accounts from a player when he joins?
# permission: /authme.admin.accounts
2013-03-09 03:42:17 +01:00
displayOtherAccounts: true
# WorldNames where we need to force the spawn location for ForceSpawnLocOnJoinEnabled
2013-03-09 03:42:17 +01:00
ForceSpawnOnTheseWorlds:
- world
- world_nether
- world_the_end
# Ban ip when the ip is not the ip registered in database
2013-03-09 03:42:17 +01:00
banUnsafedIP: false
GameMode:
# ForceSurvivalMode to player when join ?
2013-03-09 03:42:17 +01:00
ForceSurvivalMode: false
# if player join with CreativeMode and ForceSurvivalMode: true
# inventory will be wipped
2013-03-09 03:42:17 +01:00
ResetInventoryIfCreative: false
# Do we need to force the survival mode ONLY after /login process ?
ForceOnlyAfterLogin: false
2013-03-09 03:42:17 +01:00
security:
# minimum Length of password
2013-03-09 03:42:17 +01:00
minPasswordLength: 4
# this is very important options,
# every time player join the server,
# if they are registered, AuthMe will switch him
# to unLoggedInGroup, this
# should prevent all major exploit.
# So you can set up on your Permission Plugin
# this special group with 0 permissions, or permissions to chat,
# or permission to
# send private message or all other perms that you want,
# the better way is to set up
# this group with few permissions,
# so if player try to exploit some account,
# they can
# do anything except what you set in perm Group.
# After a correct logged-in player will be
# moved to his correct permissions group!
# Pay attention group name is case sensitive,
# so Admin is different from admin,
# otherwise your group will be wiped,
# and player join in default group []!
# Example unLoggedinGroup: NotLogged
2013-03-09 03:42:17 +01:00
unLoggedinGroup: unLoggedinGroup
# possible values: MD5, SHA1, SHA256, WHIRLPOOL, XAUTH, MD5VB, PHPBB,
# PLAINTEXT ( unhashed password),
# MYBB, IPB3, PHPFUSION, SMF, XENFORO, SALTED2MD5, JOOMLA, BCRYPT, WBB3, SHA512,
# DOUBLEMD5, PBKDF2, WORDPRESS, CUSTOM(for developpers only)
2013-03-09 03:42:17 +01:00
passwordHash: SHA256
# salt length for the SALTED2MD5 MD5(MD5(password)+salt)
2013-03-09 03:42:17 +01:00
doubleMD5SaltLength: 8
# If password checking return false , do we need to check with all
# other password algorithm to check an old password ?
# AuthMe will update the password to the new passwordHash !
supportOldPasswordHash: false
2013-03-09 03:42:17 +01:00
registration:
# enable registration on the server?
2013-03-09 03:42:17 +01:00
enabled: true
# Send every X seconds a message to a player to
# remind him that he has to login/register
2013-03-09 03:42:17 +01:00
messageInterval: 5
# Only registered and logged in players can play.
# See restrictions for exceptions
2013-03-09 03:42:17 +01:00
force: true
# Does we replace password registration by an Email registration method ?
2013-03-09 03:42:17 +01:00
enableEmailRegistrationSystem: false
# Enable double check of email when you register
# when it's true, registration require that kind of command:
# /register <email> <confirmEmail>
2013-03-09 03:42:17 +01:00
doubleEmailCheck: false
unrestrictions:
# below you can list all your account name, that
# AuthMe will ignore for registration or login, configure it
# at your own risk!! Remember that if you are going to add
# nickname with [], you have to delimit name with ' '.
# this option add compatibility with BuildCraft and some
# other mods.
# It is CaseSensitive!
2013-03-09 03:42:17 +01:00
UnrestrictedName: []
# Message language, available : en, de, br, cz, pl, fr, ru, hu, sk, es, zhtw, fi, zhcn, lt, it, ko, pt
2013-03-09 03:42:17 +01:00
messagesLanguage: en
ExternalBoardOptions:
# MySQL column for the salt , needed for some forum/cms support
2013-03-09 03:42:17 +01:00
mySQLColumnSalt: ''
# MySQL column for the group, needed for some forum/cms support
2013-03-09 03:42:17 +01:00
mySQLColumnGroup: ''
# -1 mean disabled. If u want that only
# activated player can login in your server
# u can put in this options the group number
# of unactivated user, needed for some forum/cms support
2013-03-09 03:42:17 +01:00
nonActivedUserGroup: -1
# Other MySQL columns where we need to put the Username
2013-03-09 03:42:17 +01:00
mySQLOtherUsernameColumns: []
# How much Log to Round needed in BCrypt(do not change it if you do not know what's your doing)
bCryptLog2Round: 10
# phpBB prefix defined during phpbb installation process
phpbbTablePrefix: 'phpbb_'
# phpBB activated group id , 2 is default registered group defined by phpbb
phpbbActivatedGroupId: 2
# WordPress prefix defined during WordPress installation process
wordpressTablePrefix: 'wp_'
2013-03-09 03:42:17 +01:00
permission:
# take care with this options, if u dont want
# to use Vault and Group Switching of
# AuthMe for unloggedIn players put False
# below, default is true.
2013-03-09 03:42:17 +01:00
EnablePermissionCheck: false
BackupSystem:
# Enable or Disable Automatic Backup
2013-03-09 03:42:17 +01:00
ActivateBackup: false
# set Backup at every start of Server
2013-03-09 03:42:17 +01:00
OnServerStart: false
# set Backup at every stop of Server
2013-03-09 03:42:17 +01:00
OnServerStop: true
# Windows only mysql installation Path
2013-03-09 03:42:17 +01:00
MysqlWindowsPath: 'C:\\Program Files\\MySQL\\MySQL Server 5.1\\'
Passpartu:
# Enable or Disable Passpartu Feature,
# this feature let Admin Login with all registered
# Account they need, for example inspecting Player that
# is doing shit, they can login without know any
# Player password! More info on How TO
2013-03-09 03:42:17 +01:00
enablePasspartu: false
Security:
SQLProblem:
# Stop the server if we can't contact the sql database
# Take care with this, if you set that to false,
# AuthMe automatically disable and the server is not protected!
2013-03-09 03:42:17 +01:00
stopServer: true
ReloadCommand:
# /reload support
2013-03-09 03:42:17 +01:00
useReloadCommandSupport: true
console:
# Remove spam console
2013-03-09 03:42:17 +01:00
noConsoleSpam: false
# Replace passwords in the console when player type a command like /login
2013-03-09 03:42:17 +01:00
removePassword: true
captcha:
# Player need to put a captcha when he fails too lot the password
2013-03-09 03:42:17 +01:00
useCaptcha: false
# Max allowed tries before request a captcha
2013-03-09 03:42:17 +01:00
maxLoginTry: 5
# Captcha length
2013-03-09 03:42:17 +01:00
captchaLength: 5
Converter:
Rakamak:
# Rakamak file name
2013-03-09 03:42:17 +01:00
fileName: users.rak
# Rakamak use ip ?
2013-03-09 03:42:17 +01:00
useIP: false
# IP file name for rakamak
2013-03-09 03:42:17 +01:00
ipFileName: UsersIp.rak
# possible values: MD5, SHA1, SHA256, WHIRLPOOL, XAUTH, MD5VB, PHPBB,
# PLAINTEXT ( unhashed password),
# MYBB, IPB3, PHPFUSION, SMF, XENFORO, SALTED2MD5, JOOMLA, BCRYPT, WBB3, SHA512,
# DOUBLEMD5, PBKDF2, WORDPRESS, CUSTOM(for developpers only)
2013-03-09 03:42:17 +01:00
newPasswordHash: SHA256
Email:
# Email SMTP server host
2013-03-09 03:42:17 +01:00
mailSMTP: smtp.gmail.com
# Email SMTP server port
2013-03-09 03:42:17 +01:00
mailPort: 465
# Email account that send the mail
2013-03-09 03:42:17 +01:00
mailAccount: ''
# Email account password
2013-03-09 03:42:17 +01:00
mailPassword: ''
# Custom SenderName, that replace the mailAccount name in the email
2013-03-09 03:42:17 +01:00
mailSenderName: ''
# Random password length
2013-03-09 03:42:17 +01:00
RecoveryPasswordLength: 8
# Email subject of password get
2013-03-09 03:42:17 +01:00
mailSubject: 'Your new AuthMe Password'
# Email text here
mailText: 'Dear <playername>, <br /><br /> This is your new AuthMe password for the server <br /><br /> <servername> : <br /><br /> <generatedpass><br /><br />Do not forget to change password after login! <br /> /changepassword <generatedpass> newPassword'
# Like maxRegPerIp but with email
2013-03-09 03:42:17 +01:00
maxRegPerEmail: 1
Hooks:
# Do we need to hook with multiverse for spawn checking?
2013-03-09 03:42:17 +01:00
multiverse: true
# Do we need to hook with ChestShop for prevent buy or selling ?
2013-03-09 03:42:17 +01:00
chestshop: true
# Do we need to hook with BungeeCord for get the real Player ip ?
2013-03-09 03:42:17 +01:00
bungeecord: false
# Do we need to hook with Notifications for Notifs sending ?
notifications: true
# Do we need to disable Essentials SocialSpy on join ?
disableSocialSpy: true
# Do we need to force /motd Essentials command on join ?
useEssentialsMotd: false
Performances:
# HIGHLY recommended to use this! This will increase database performance
# Default is false due to little servers
useMultiThreading: false
Purge:
# On Enable , does AuthMe need to purge automatically old accounts unused ?
useAutoPurge: false
# Number of Days an account become Unused
daysBeforeRemovePlayer: 60
# Do we need to remove the player.dat file during purge process ?
removePlayerDat: false
# Do we need to remove the Essentials/users/player.yml file during purge proecess ?
removeEssentialsFile: false
# World where are players.dat stores
defaultWorld: 'world'