|
1 | 1 | <!-- AUTO-GENERATED FILE! Do not edit this directly --> |
2 | | -<!-- File auto-generated on Thu Jul 28 18:11:22 CEST 2022. See docs/config/config.tpl.md --> |
| 2 | +<!-- File auto-generated on Mon Apr 20 11:07:35 CEST 2026. See authme-core/src/test/java/tools/docs/config/config.tpl.md --> |
3 | 3 |
|
4 | 4 | ## AuthMe Configuration |
5 | 5 | The first time you run AuthMe it will create a config.yml file in the plugins/AuthMe folder, |
6 | 6 | with which you can configure various settings. The following is the initial contents of |
7 | 7 | the generated config.yml file. |
8 | 8 |
|
| 9 | +This configuration is generated from the shared `authme-core` module. It applies to the |
| 10 | +current Spigot Legacy, Spigot 1.21, and Paper 1.21 builds unless a setting comment says otherwise. |
| 11 | + |
9 | 12 | ```yml |
10 | 13 | DataSource: |
11 | 14 | # What type of database do you want to use? |
@@ -251,7 +254,7 @@ settings: |
251 | 254 | # Maximum length of password |
252 | 255 | passwordMaxLength: 30 |
253 | 256 | # Possible values: SHA256, BCRYPT, BCRYPT2Y, PBKDF2, SALTEDSHA512, |
254 | | - # MYBB, IPB3, PHPBB, PHPFUSION, SMF, XENFORO, XAUTH, JOOMLA, WBB3, WBB4, MD5VB, |
| 257 | + # MYBB, IPB3, PHPBB, PHPFUSION, SMF, XENFORO, JOOMLA, WBB3, WBB4, MD5VB, |
255 | 258 | # PBKDF2DJANGO, WORDPRESS, ROYALAUTH, ARGON2, CUSTOM (for developers only). See full list at |
256 | 259 | # https://github.com/AuthMe/AuthMeReloaded/blob/master/docs/hash_algorithms.md |
257 | 260 | # If you use ARGON2, check that you have the argon2 c library on your system |
@@ -304,6 +307,10 @@ settings: |
304 | 307 | forceKickAfterRegister: false |
305 | 308 | # Does AuthMe need to enforce a /login after a successful registration? |
306 | 309 | forceLoginAfterRegister: false |
| 310 | + # Show a graphical dialog UI for login/register instead of chat messages. |
| 311 | + # Requires Minecraft 1.21.6+ on Spigot, or 1.21.11+ on Paper. |
| 312 | + # On older server versions, this option is automatically ignored. |
| 313 | + useDialogUi: true |
307 | 314 | # Enable to display the welcome message (welcome.txt) after a login |
308 | 315 | # You can use colors in this welcome.txt + some replaced strings: |
309 | 316 | # {PLAYER}: player name, {ONLINE}: display number of online players, |
@@ -355,9 +362,15 @@ GroupOptions: |
355 | 362 | Email: |
356 | 363 | # Email SMTP server host |
357 | 364 | mailSMTP: smtp.gmail.com |
358 | | - # Email SMTP server port |
| 365 | + # Email SMTP server port. The port determines the encryption mode: |
| 366 | + # 25 -> plain SMTP; optional STARTTLS via 'useTls' (see below) |
| 367 | + # 465 -> implicit SSL/TLS (SMTPS); 'useTls' is ignored |
| 368 | + # 587 -> STARTTLS required (submission); 'useTls' is ignored |
| 369 | + # other -> STARTTLS required; 'useTls' is ignored |
359 | 370 | mailPort: 465 |
360 | | - # Only affects port 25: enable TLS/STARTTLS? |
| 371 | + # Only applies to port 25: enable STARTTLS on the plain SMTP connection? |
| 372 | + # Has no effect when using port 465 (SSL) or 587 (STARTTLS), which enforce |
| 373 | + # their own encryption and cannot be overridden by this setting. |
361 | 374 | useTls: true |
362 | 375 | # Email account which sends the mails |
363 | 376 | mailAccount: '' |
@@ -386,6 +399,13 @@ Email: |
386 | 399 | generateImage: false |
387 | 400 | # The OAuth2 token |
388 | 401 | emailOauth2Token: '' |
| 402 | + # Verify the SSL/TLS server certificate hostname? |
| 403 | + # Only applies when an SSL/TLS connection is active (port 465, port 587, |
| 404 | + # port 25 with useTls=true, or any other port). |
| 405 | + # Set to false only if your SMTP server uses a self-signed certificate. |
| 406 | + # Note: if you previously used port 465, this check was not enforced; |
| 407 | + # set to false to restore the old behavior with a self-signed certificate. |
| 408 | + sslCheckServerIdentity: true |
389 | 409 | Hooks: |
390 | 410 | # Do we need to hook with multiverse for spawn checking? |
391 | 411 | multiverse: true |
@@ -590,4 +610,4 @@ To change settings on a running server, save your changes to config.yml and use |
590 | 610 |
|
591 | 611 | --- |
592 | 612 |
|
593 | | -This page was automatically generated on the [AuthMe/AuthMeReloaded repository](https://github.com/AuthMe/AuthMeReloaded/tree/master/docs/) on Thu Jul 28 18:11:22 CEST 2022 |
| 613 | +This page was automatically generated on the [AuthMe/AuthMeReloaded repository](https://github.com/AuthMe/AuthMeReloaded/tree/master/docs/) on Mon Apr 20 11:07:35 CEST 2026 |
0 commit comments