#519 #515 #431 Tool task to update all docs; relocate to root/docs

- Move docs from src/tools to a root subfolder - Add tag for displaying a "generated page" footer - Create task to run all doc tasks - Remove map builder in favor of Guava's
2016-02-14 21:43:01 +01:00
parent 76e7728b37
commit 7f3246e416
15 changed files with 124 additions and 87 deletions
@@ -0,0 +1,80 @@
+<!-- AUTO-GENERATED FILE! Do not edit this directly -->
+<!-- File auto-generated on Sun Feb 14 19:00:30 CET 2016. See commands/commands.tpl.md -->
+
+## AuthMe Commands
+You can use the following commands to use the features of AuthMe. Mandatory arguments are marked with `< >`
+brackets; optional arguments are enclosed in square brackets (`[ ]`).
+
+- **/authme**: The main AuthMeReloaded command. The root for all admin commands.
+- **/authme register** &lt;player> &lt;password>: Register the specified player with the specified password.
+<br />Requires `authme.admin.register`
+- **/authme unregister** &lt;player>: Unregister the specified player.
+<br />Requires `authme.admin.unregister`
+- **/authme forcelogin** [player]: Enforce the specified player to login.
+<br />Requires `authme.player.canbeforced`
+- **/authme password** &lt;player> &lt;pwd>: Change the password of a player.
+<br />Requires `authme.admin.changepassword`
+- **/authme lastlogin** [player]: View the date of the specified players last login.
+<br />Requires `authme.admin.lastlogin`
+- **/authme accounts** [player]: Display all accounts of a player by his player name or IP.
+<br />Requires `authme.admin.accounts`
+- **/authme email** [player]: Display the email address of the specified player if set.
+<br />Requires `authme.admin.getemail`
+- **/authme setemail** &lt;player> &lt;email>: Change the email address of the specified player.
+<br />Requires `authme.admin.changemail`
+- **/authme getip** &lt;player>: Get the IP address of the specified online player.
+<br />Requires `authme.admin.getip`
+- **/authme spawn** &lt;player>: Teleport to the spawn.
+<br />Requires `authme.admin.spawn`
+- **/authme setspawn**: Change the player's spawn to your current position.
+<br />Requires `authme.admin.setspawn`
+- **/authme firstspawn**: Teleport to the first spawn.
+<br />Requires `authme.admin.firstspawn`
+- **/authme setfirstspawn**: Change the first player's spawn to your current position.
+<br />Requires `authme.admin.setfirstspawn`
+- **/authme purge** &lt;days>: Purge old AuthMeReloaded data longer than the specified amount of days ago.
+<br />Requires `authme.admin.purge`
+- **/authme resetpos** &lt;player/*>: Purge the last know position of the specified player or all of them.
+<br />Requires `authme.admin.purgelastpos`
+- **/authme purgebannedplayers**: Purge all AuthMeReloaded data for banned players.
+<br />Requires `authme.admin.purgebannedplayers`
+- **/authme switchantibot** [mode]: Switch or toggle the AntiBot mode to the specified state.
+<br />Requires `authme.admin.switchantibot`
+- **/authme reload**: Reload the AuthMeReloaded plugin.
+<br />Requires `authme.admin.reload`
+- **/authme version**: Show detailed information about the installed AuthMeReloaded version, the developers, contributors, and license.
+- **/authme help** [query]: View detailed help for /authme commands.
+- **/login** &lt;password>: Command to log in using AuthMeReloaded.
+<br />Requires `authme.player.login`
+- **/login help** [query]: View detailed help for /login commands.
+- **/logout**: Command to logout using AuthMeReloaded.
+<br />Requires `authme.player.logout`
+- **/logout help** [query]: View detailed help for /logout commands.
+- **/register** [password] [verifyPassword]: Command to register using AuthMeReloaded.
+<br />Requires `authme.player.register`
+- **/register help** [query]: View detailed help for /register commands.
+- **/unreg** &lt;password>: Command to unregister using AuthMeReloaded.
+<br />Requires `authme.player.unregister`
+- **/unreg help** [query]: View detailed help for /unreg commands.
+- **/changepassword** &lt;oldPassword> &lt;newPassword>: Command to change your password using AuthMeReloaded.
+<br />Requires `authme.player.changepassword`
+- **/changepassword help** [query]: View detailed help for /changepassword commands.
+- **/email**: The AuthMeReloaded Email command base.
+- **/email add** &lt;email> &lt;verifyEmail>: Add a new email address to your account.
+<br />Requires `authme.player.email.add`
+- **/email change** &lt;oldEmail> &lt;newEmail>: Change an email address of your account.
+<br />Requires `authme.player.email.change`
+- **/email recover** &lt;email>: Recover your account using an Email address by sending a mail containing a new password.
+<br />Requires `authme.player.email.recover`
+- **/email help** [query]: View detailed help for /email commands.
+- **/captcha** &lt;captcha>: Captcha command for AuthMeReloaded.
+<br />Requires `authme.player.captcha`
+- **/captcha help** [query]: View detailed help for /captcha commands.
+- **/converter** &lt;job>: Converter command for AuthMeReloaded.
+<br />Requires `authme.admin.converter`
+- **/converter help** [query]: View detailed help for /converter commands.
+
+
+---
+
+This page was automatically generated on the [AuthMe-Team/AuthMeReloaded repository](https://github.com/AuthMe-Team/AuthMeReloaded/tree/master/docs/) on Sun Feb 14 19:00:30 CET 2016
@@ -0,0 +1,85 @@
+<!-- AUTO-GENERATED FILE! Do not edit this directly -->
+<!-- File auto-generated on Sun Feb 14 19:00:32 CET 2016. See hashmethods/hash_algorithms.tpl.md -->
+
+## Hash Algorithms
+AuthMe supports the following hash algorithms for storing your passwords safely.
+
+
+Algorithm | Recommendation | Hash length | ASCII |     | Salt type | Length | Separate?
+--------- | -------------- | ----------- | ----- | --- | --------- | ------ | ---------
+BCRYPT | Recommended | 60 |  | | Text |  | 
+BCRYPT2Y | Recommended | 60 |  | | Text | 22 | 
+CRAZYCRYPT1 | Do not use | 128 |  | | Username |  | 
+DOUBLEMD5 | Do not use | 32 |  | | None |  | 
+IPB3 | Acceptable | 32 |  | | Text | 5 | Y
+IPB4 | Does not work | 60 |  | | Text | 22 | Y
+JOOMLA | Recommended | 65 |  | | Text | 32 | 
+MD5 | Do not use | 32 |  | | None |  | 
+MD5VB | Acceptable | 56 |  | | Text | 16 | 
+MYBB | Acceptable | 32 |  | | Text | 8 | Y
+PBKDF2 | Does not work | 330 |  | | Text | 12 | 
+PBKDF2DJANGO | Acceptable | 77 | Y | | Text | 12 | 
+PHPBB | Acceptable | 34 |  | | Text | 16 | 
+PHPFUSION | Do not use | 64 | Y | |  |  | Y
+ROYALAUTH | Do not use | 128 |  | | None |  | 
+SALTED2MD5 | Acceptable | 32 |  | | Text |  | Y
+SALTEDSHA512 | Recommended | 128 |  | |  |  | Y
+SHA1 | Do not use | 40 |  | | None |  | 
+SHA256 | Recommended | 86 |  | | Text | 16 | 
+SHA512 | Do not use | 128 |  | | None |  | 
+SMF | Do not use | 40 |  | | Username |  | 
+TWO_FACTOR | Does not work | 16 |  | | None |  | 
+WBB3 | Acceptable | 40 |  | | Text | 40 | Y
+WBB4 | Recommended | 60 |  | | Text | 8 | 
+WHIRLPOOL | Do not use | 128 |  | | None |  | 
+WORDPRESS | Acceptable | 34 |  | | Text | 9 | 
+XAUTH | Recommended | 140 |  | | Text | 12 | 
+XFBCRYPT |  | 60 |  | |  |  | 
+CUSTOM |  |  |  |  |  |  |  |
+
+<!-- AUTO-GENERATED FILE! Do not edit this directly -->
+
+### Columns
+#### Algorithm
+The algorithm is the hashing algorithm used to store passwords with. Default is SHA256 and is recommended.
+You can change the hashing algorithm in the config.yml: under `security`, locate `passwordHash`.
+
+#### Recommendation
+The recommendation lists our usage recommendation in terms of how secure it is (not how _well_ the algorithm works!).
+- Recommended: The hash algorithm appears to be cryptographically secure and is one we recommend.
+- Acceptable: There are safer algorithms that can be chosen but using the algorithm is generally OK.
+- Do not use: Hash algorithm isn't sufficiently secure. Use only if required to hook into another system.
+- Does not work: The algorithm does not work properly; do not use.
+
+#### Hash Length
+The length of the hashes the algorithm produces. Note that the hash length is not (primarily) indicative of
+whether an algorithm is secure or not.
+
+#### ASCII
+If denoted with a **y**, means that the algorithm is restricted to ASCII characters only, i.e. it will simply ignore
+"special characters" such as `ÿ` or `Â`. Note that we do not recommend the use of "special characters" in passwords.
+
+#### Salt Columns
+Before hashing, a _salt_ may be appended to the password to make the hash more secure. The following columns describe
+the salt the algorithm uses.
+<!-- AUTO-GENERATED FILE! Do not edit this directly -->
+
+##### Salt Type
+We do not recommend the usage
+of any algorithm that doesn't use a randomly generated text as salt. This "salt type" column indicates what type of
+salt the algorithm uses:
+- Text: randomly generated text (see also the following column, "Length")
+- Username: the salt is constructed from the username (bad)
+- None: the algorithm uses no salt (bad)
+
+##### Length
+If applicable (salt type is "Text"), indicates the length of the generated salt. The longer the better.
+If this column is empty when the salt type is "Text", it typically means the salt length can be defined in config.yml.
+
+##### Separate
+If denoted with a **y**, it means that the salt is stored in a separate column in the database. This is neither good
+or bad.
+
+---
+
+This page was automatically generated on the [AuthMe-Team/AuthMeReloaded repository](https://github.com/AuthMe-Team/AuthMeReloaded/tree/master/docs/) on Sun Feb 14 19:00:32 CET 2016
@@ -0,0 +1,48 @@
+<!-- AUTO-GENERATED FILE! Do not edit this directly -->
+<!-- File auto-generated on Sun Feb 14 19:00:34 CET 2016. See permissions/permission_nodes.tpl.md -->
+
+## AuthMe Permission Nodes
+The following are the permission nodes that are currently supported by the latest dev builds.
+
+- **authme.admin.*** – Give access to all admin commands.
+- **authme.admin.accounts** – Administrator command to see all accounts associated with a user.
+- **authme.admin.changemail** – Administrator command to set or change the email address of a user.
+- **authme.admin.changepassword** – Administrator command to change the password of a user.
+- **authme.admin.converter** – Administrator command to convert old or other data to AuthMe data.
+- **authme.admin.firstspawn** – Administrator command to teleport to the first AuthMe spawn.
+- **authme.admin.forcelogin** – Administrator command to force-login an existing user.
+- **authme.admin.getemail** – Administrator command to get the email address of a user, if set.
+- **authme.admin.getip** – Administrator command to get the last known IP of a user.
+- **authme.admin.lastlogin** – Administrator command to see the last login date and time of a user.
+- **authme.admin.purge** – Administrator command to purge old user data.
+- **authme.admin.purgebannedplayers** – Administrator command to purge all data associated with banned players.
+- **authme.admin.purgelastpos** – Administrator command to purge the last position of a user.
+- **authme.admin.register** – Administrator command to register a new user.
+- **authme.admin.reload** – Administrator command to reload the plugin configuration.
+- **authme.admin.seeotheraccounts** – Permission to see the other accounts of the players that log in.
+- **authme.admin.setfirstspawn** – Administrator command to set the first AuthMe spawn.
+- **authme.admin.setspawn** – Administrator command to set the AuthMe spawn.
+- **authme.admin.spawn** – Administrator command to teleport to the AuthMe spawn.
+- **authme.admin.switchantibot** – Administrator command to toggle the AntiBot protection status.
+- **authme.admin.unregister** – Administrator command to unregister an existing user.
+- **authme.allowmultipleaccounts** – Permission to be able to register multiple accounts.
+- **authme.bypassantibot** – Permission node to bypass AntiBot protection.
+- **authme.bypassforcesurvival** – Permission for users to bypass force-survival mode.
+- **authme.player.*** – Permission to use all player (non-admin) commands.
+- **authme.player.canbeforced** – Permission for users a login can be forced to.
+- **authme.player.captcha** – Command permission to use captcha.
+- **authme.player.changepassword** – Command permission to change the password.
+- **authme.player.email.add** – Command permission to add an email address.
+- **authme.player.email.change** – Command permission to change the email address.
+- **authme.player.email.recover** – Command permission to recover an account using it's email address.
+- **authme.player.login** – Command permission to login.
+- **authme.player.logout** – Command permission to logout.
+- **authme.player.register** – Command permission to register.
+- **authme.player.seeownaccounts** – Permission to use to see own other accounts.
+- **authme.player.unregister** – Command permission to unregister.
+- **authme.vip** – Permission node to identify VIP users.
+
+
+---
+
+This page was automatically generated on the [AuthMe-Team/AuthMeReloaded repository](https://github.com/AuthMe-Team/AuthMeReloaded/tree/master/docs/) on Sun Feb 14 19:00:34 CET 2016