====== Login ======

The configured Login Module is executed for the following [[server:Terminal]] Server connections:
   * All Telnet connections
   * Unauthenticated SSH and RLogin connections

This module is responsible for querying the user's login ID and initiating the login process.

The name of the login module (by default, ''login'') is configured in [[util:SCFG]]->System->Loadable Modules->Login.

The [[https://gitlab.synchro.net/main/sbbs/-/blob/master/exec/login.js|default login module]] is ''[[dir:exec]]/login.js'' and supports the following configuration options in the ''[login]'' section of the ''[[dir:ctrl]]/[[config:modopts.ini]]'' file:

^ Option ^ Default      ^ Description ^
| email_passwords       | ''true''  | Send forgotten passwords to users via [[server:mail|email (SMTP)]] |
| confirm_email_address | ''true''  | Requires user to confirm their email address before sending a forgotten password |
| login_prompts         | ''10''    | Maximum number of login prompts to display before disconnecting |
| login_prompt          | <see code> | Override default dynamically-generated //login// prompt |
| password_prompt       | <see code> | Override default //password// prompt |
| guest                 | ''true''  | Display the "or Guest" login suggestion when a "Guest" user account exists |
| legacy_prompts        | ''false'' | Send legacy name/number/password prompts (''NN:'' and ''PW:'') followed by bare carriage returns, to support really old login scripts |

===== Customize =====

If you choose to use a customized or entirely different login module, it is recommended that you use a different module name (not "login") and/or copy the login module to your ''[[dir:mods]]'' directory before modifying.

===== See Also =====
  * [[:module:|Modules]]
  * [[:module:Logon]] Module
  * [[:dir:exec]] Directory
  * [[:dir:mods]] Directory
