summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/account.md30
-rw-r--r--docs/account_access.md2
-rw-r--r--docs/account_banned.md4
-rw-r--r--docs/account_muted.md8
-rw-r--r--docs/autobroadcast.md4
-rw-r--r--docs/build_info.md30
-rw-r--r--docs/ip_banned.md8
-rw-r--r--docs/logs.md9
-rw-r--r--docs/logs_ip_actions.md40
-rw-r--r--docs/realmcharacters.md10
-rw-r--r--docs/realmlist.md22
-rw-r--r--docs/secret_digest.md10
-rw-r--r--docs/uptime.md8
-rw-r--r--docs/version_db_auth.md21
14 files changed, 111 insertions, 95 deletions
diff --git a/docs/account.md b/docs/account.md
index 00e14cf..e1a8c64 100644
--- a/docs/account.md
+++ b/docs/account.md
@@ -37,17 +37,17 @@
[2]: #username
[3]: #salt
[4]: #verifier
-[5]: #session_key
-[6]: #totp_secret
+[5]: #sessionkey
+[6]: #totpsecret
[7]: #email
-[8]: #reg_mail
+[8]: #regmail
[9]: #joindate
-[10]: #last_ip
-[11]: #last_attempt_ip
-[12]: #failed_logins
+[10]: #lastip
+[11]: #last_attemptip
+[12]: #failedlogins
[13]: #locked
-[14]: #lock_country
-[15]: #last_login
+[14]: #lockcountry
+[15]: #lastlogin
[16]: #online
[17]: #expansion
[18]: #mutetime
@@ -108,17 +108,17 @@ Make sure the PHP GMP extension is loaded! Uncomment `extension=gmp` in your php
[VerifySRP6Login.php](https://gist.github.com/Treeston/34d9249fb467dddc11b2568e74f8cb1e)
-### session_key
+### session\_key
`field-no-description|5`
-### totp_secret
+### totp\_secret
The authenticator key.
Key can be generated through the Google Authenticator API, a 3rd-party TOTP generator, or manually specified (must be a Base32-compliant expression that is 16 characters).
-Implementation link on Wikipedia for the Google Authenticator API
+Implementation link on Wikipedia for the Google Authenticator API.
<http://en.wikipedia.org/wiki/Google_Authenticator#Implementations>
@@ -126,7 +126,7 @@ Implementation link on Wikipedia for the Google Authenticator API
The e-mail address associated with this account.
-### reg_mail
+### reg\_mail
The registration e-mail address associated with this account.
@@ -134,11 +134,11 @@ The registration e-mail address associated with this account.
The date when the account was created.
-### last_ip
+### last\_ip
The last IP used by the person who logged in the account.
-### failed_logins
+### failed\_logins
The number of failed logins attempted on the account.
@@ -146,7 +146,7 @@ The number of failed logins attempted on the account.
Boolean 0 or 1 controlling if the account has been locked or not. This can be controlled with the ".account lock" GM command. If locked (1), the user can only log in with their [last_ip][11]. If unlocked (0), a user can log in from any IP, and their last_ip will be updated if it is different. ".Ban account" does not lock it.
-### last_login
+### last\_login
The date when the account was last logged into.
diff --git a/docs/account_access.md b/docs/account_access.md
index 29d8263..5318e97 100644
--- a/docs/account_access.md
+++ b/docs/account_access.md
@@ -13,7 +13,7 @@ This table holds security access level for any realm in [realmlist](realmlist) t
| [id][1] | INT | UNSIGNED | PRI | NO | | | |
| [gmlevel][2] | TINYINT | UNSIGNED | | NO | | | |
| [RealmID][3] | INT | SIGNED | PRI | NO | -1 | | |
-| [comment][4] | VARCHAR(255) | | | YES | '' | | |
+| [comment][4] | VARCHAR(255) | SIGNED | | YES | '' | | |
[1]: #id
[2]: #gmlevel
diff --git a/docs/account_banned.md b/docs/account_banned.md
index da7f763..4340570 100644
--- a/docs/account_banned.md
+++ b/docs/account_banned.md
@@ -13,8 +13,8 @@ This table lists all of the accounts that have been banned along with the date w
| [id][1] | INT | UNSIGNED | PRI | NO | 0 | | Account id |
| [bandate][2] | INT | UNSIGNED | PRI | NO | 0 | | |
| [unbandate][3] | INT | UNSIGNED | | NO | 0 | | |
-| [bannedby][4] | VARCHAR(50) | | | NO | | | |
-| [banreason][5] | VARCHAR(255) | | | NO | | | |
+| [bannedby][4] | VARCHAR(50) | SIGNED | | NO | | | |
+| [banreason][5] | VARCHAR(255) | SIGNED | | NO | | | |
| [active][6] | TINYINT | UNSIGNED | | NO | 1 | | |
[1]: #id
diff --git a/docs/account_muted.md b/docs/account_muted.md
index 97353c9..d3e19c9 100644
--- a/docs/account_muted.md
+++ b/docs/account_muted.md
@@ -17,8 +17,8 @@ Disable chat messaging for any character from account of character $playerName (
| [guid][1] | INT | UNSIGNED | PRI | NO | 0 | | Global Unique Identifier |
| [mutedate][2] | INT | UNSIGNED | PRI | NO | 0 | | |
| [mutetime][3] | INT | UNSIGNED | | NO | 0 | | |
-| [mutedby][4] | VARCHAR(50) | | | NO | | | |
-| [mutereason][5] | VARCHAR(255) | | | NO | | | |
+| [mutedby][4] | VARCHAR(50) | SIGNED | | NO | | | |
+| [mutereason][5] | VARCHAR(255) | SIGNED | | NO | | | |
[1]: #guid
[2]: #mutedate
@@ -26,11 +26,11 @@ Disable chat messaging for any character from account of character $playerName (
[4]: #mutedby
[5]: #mutereason
-### Description of the fields
+**Description of the fields**
### guid
-ID of muted account, taken from muted character. All characters on this account will be muted for [mutetime](#mutetime).
+ID of muted [account](account#id), taken from muted character. All characters on this account will be muted for [mutetime](#mutetime).
### mutedate
diff --git a/docs/autobroadcast.md b/docs/autobroadcast.md
index a39094a..b500729 100644
--- a/docs/autobroadcast.md
+++ b/docs/autobroadcast.md
@@ -13,7 +13,7 @@ This table contains the autobroadcast entries for your realms. Values like it's
| [realmid][1] | INT | SIGNED | PRI | NO | -1 | | |
| [id][2] | TINYINT | UNSIGNED | PRI | NO | | AUTO_INCREMENT | |
| [weight][3] | TINYINT | UNSIGNED | | YES | 1 | | |
-| [text][4] | LONGTEXT | | | NO | | | |
+| [text][4] | LONGTEXT | SIGNED | | NO | | | |
[1]: #realmid
[2]: #id
@@ -24,7 +24,7 @@ This table contains the autobroadcast entries for your realms. Values like it's
### realmid
-The [realmlist.id](realmlist). Defines which realm this entry belongs to. Use **-1** for all realms to load this entry.
+The [realmlist.id](realmlist#id). Defines which realm this entry belongs to. Use **-1** for all realms to load this entry.
### id
diff --git a/docs/build_info.md b/docs/build_info.md
index c9bdac4..3caf047 100644
--- a/docs/build_info.md
+++ b/docs/build_info.md
@@ -1,23 +1,23 @@
-# account
+# build\_info
[<-Back-to:Auth](database-auth.md)
-**The \`build_info\` table**
+**The \`build\_info\` table**
**Structure**
-| Field | Type | Attributes | Key | Null | Default | Extra | Comment |
-|-----------------------|--------------|------------|-----|------|-------------------|----------------|------------|
-| [build][1] | INT | | PRI | NO | | | Identifier |
-| [majorVersion][2] | INT | | | YES | NULL | | |
-| [minorVersion][3] | INT | | | YES | NULL | | |
-| [bugfixVersion][4] | INT | | | YES | NULL | | |
-| [hotfixVersion][5] | CHAR(3) | | | YES | NULL | | |
-| [winAuthSeed][6] | VARCHAR(32) | | | YES | NULL | | |
-| [win64AuthSeed][7] | VARCHAR(32) | | | YES | NULL | | |
-| [mac64AuthSeed][8] | VARCHAR(32) | | | YES | NULL | | |
-| [winChecksumSeed][9] | VARCHAR(40) | | | YES | NULL | | |
-| [macChecksumSeed][10] | VARCHAR(40) | | | YES | NULL | | |
+| Field | Type | Attributes | Key | Null | Default | Extra | Comment |
+| --------------------- | ------------ | ---------- | --- | ---- | ------- | ----- |----------- |
+| [build][1] | INT | SIGNED | PRI | NO | | | Identifier |
+| [majorVersion][2] | INT | SIGNED | | YES | | | |
+| [minorVersion][3] | INT | SIGNED | | YES | | | |
+| [bugfixVersion][4] | INT | SIGNED | | YES | | | |
+| [hotfixVersion][5] | CHAR(3) | SIGNED | | YES | | | |
+| [winAuthSeed][6] | VARCHAR(32) | SIGNED | | YES | | | |
+| [win64AuthSeed][7] | VARCHAR(32) | SIGNED | | YES | | | |
+| [mac64AuthSeed][8] | VARCHAR(32) | SIGNED | | YES | | | |
+| [winChecksumSeed][9] | VARCHAR(40) | SIGNED | | YES | | | |
+| [macChecksumSeed][10] | VARCHAR(40) | SIGNED | | YES | | | |
[1]: #build
[2]: #majorversion
@@ -30,7 +30,7 @@
[9]: #winchecksumseed
[10]: #macchecksumseed
-## Description of the fields
+**Description of the fields**
### build
diff --git a/docs/ip_banned.md b/docs/ip_banned.md
index 7e87843..9eda028 100644
--- a/docs/ip_banned.md
+++ b/docs/ip_banned.md
@@ -9,12 +9,12 @@ This table contains all of the banned IPs and the date when (or if) the ban will
**Structure**
| Field | Type | Attributes | Key | Null | Default | Extra | Comment |
-|----------------|--------------|------------|-----|------|-----------|-------|---------|
-| [ip][1] | VARCHAR(15) | | PRI | NO | 127.0.0.1 | | |
+| -------------- | ------------ | ---------- | --- | ---- | --------- | ----- | ------- |
+| [ip][1] | VARCHAR(15) | SIGNED | PRI | NO | 127.0.0.1 | | |
| [bandate][2] | INT | UNSIGNED | PRI | NO | | | |
| [unbandate][3] | INT | UNSIGNED | | NO | | | |
-| [bannedby][4] | VARCHAR(50) | | | NO | [Console] | | |
-| [banreason][5] | VARCHAR(255) | | | NO | no reason | | |
+| [bannedby][4] | VARCHAR(50) | SIGNED | | NO | [Console] | | |
+| [banreason][5] | VARCHAR(255) | SIGNED | | NO | no reason | | |
[1]: #ip
[2]: #bandate
diff --git a/docs/logs.md b/docs/logs.md
index 034a1ea..236eda1 100644
--- a/docs/logs.md
+++ b/docs/logs.md
@@ -6,6 +6,7 @@
This table stores logs from `Appender` type database in config file.
Example db appender:
+
```ini
Appender.DB=3,5,0
```
@@ -13,12 +14,12 @@ Appender.DB=3,5,0
**Structure**
| Field | Type | Attributes | Key | Null | Default | Extra | Comment |
-|-------------|--------------|------------|-----|------|---------|-------|---------|
+| ----------- | ------------ | ---------- | --- | ---- | ------- | ----- | ------- |
| [time][1] | INT | UNSIGNED | | NO | | | |
| [realm][2] | INT | UNSIGNED | | NO | | | |
-| [type][3] | VARCHAR(250) | | | NO | | | |
+| [type][3] | VARCHAR(250) | SIGNED | | NO | | | |
| [level][4] | TINYINT | UNSIGNED | | NO | 0 | | |
-| [string][5] | TEXT | | | YES | | | |
+| [string][5] | TEXT | SIGNED | | YES | | | |
[1]: #time
[2]: #realm
@@ -49,7 +50,7 @@ Logger.server=4,Console Server
Depends on LogLevel in authserver.conf
| Value | Description |
-|-------|-------------|
+|------ | ------------|
| 1 | (Fatal) |
| 2 | (Error) |
| 3 | (Warning) |
diff --git a/docs/logs_ip_actions.md b/docs/logs_ip_actions.md
index e138f19..91b3b35 100644
--- a/docs/logs_ip_actions.md
+++ b/docs/logs_ip_actions.md
@@ -4,23 +4,23 @@
**The \`logs\_ip\_actions\` table**
-## Structure
+**Structure**
| Field | Type | Attributes | Key | Null | Default | Extra | Comment |
-|---------------------|-------------|------------|-----|------|-------------------|----------------|-------------------------------|
+| ------------------- | ----------- | ---------- | --- | ---- | ----------------- | -------------- | ----------------------------- |
| [id][1] | INT | UNSIGNED | PRI | NO | | AUTO_INCREMENT | Unique Identifier |
| [account_id][2] | INT | UNSIGNED | | NO | | | Account ID |
| [character_guid][3] | INT | UNSIGNED | | NO | | | Character Guid |
| [type][4] | TINYINT | UNSIGNED | | NO | | | |
-| [ip][5] | VARCHAR(15) | | | NO | 127.0.0.1 | | |
-| [systemnote][6] | TEXT | | | YES | | | Notes inserted by system |
+| [ip][5] | VARCHAR(15) | SIGNED | | NO | 127.0.0.1 | | |
+| [systemnote][6] | TEXT | SIGNED | | YES | | | Notes inserted by system |
| [unixtime][7] | INT | UNSIGNED | | NO | | | Unixtime |
-| [time][8] | TIMESTAMP | | | NO | CURRENT_TIMESTAMP | | Timestamp |
-| [comment][9] | TEXT | | | YES | | | Allows users to add a comment |
+| [time][8] | TIMESTAMP | SIGNED | | NO | CURRENT_TIMESTAMP | | Timestamp |
+| [comment][9] | TEXT | SIGNED | | YES | | | Allows users to add a comment |
[1]: #id
-[2]: #account_id
-[3]: #character_guid
+[2]: #accountid
+[3]: #characterguid
[4]: #type
[5]: #ip
[6]: #systemnote
@@ -28,22 +28,40 @@
[8]: #time
[9]: #comment
-## Description of the fields
+**Description of the fields**
### id
-### account_id
+`field-no-description|1`
-### character_guid
+### account\_id
+
+`field-no-description|2`
+
+### character\_guid
+
+`field-no-description|3`
### type
+`field-no-description|4`
+
### ip
+`field-no-description|5`
+
### systemnote
+`field-no-description|6`
+
### unixtime
+`field-no-description|7`
+
### time
+`field-no-description|8`
+
### comment
+
+`field-no-description|9`
diff --git a/docs/realmcharacters.md b/docs/realmcharacters.md
index e2ef446..ed00c61 100644
--- a/docs/realmcharacters.md
+++ b/docs/realmcharacters.md
@@ -7,10 +7,10 @@
This table holds information on the number of characters each account has for each realm.
The data in this table is maintained by the core.
-## Structure
+**Structure**
| Field | Type | Attributes | Key | Null | Default | Extra | Comment |
-|---------------|------------|------------|-----|------|---------|-------|---------|
+| ------------- | ---------- | ---------- | --- | ---- | ------- | ----- | ------- |
| [realmid][1] | INT | UNSIGNED | PRI | NO | 0 | | |
| [acctid][2] | INT | UNSIGNED | PRI | NO | | | |
| [numchars][3] | TINYINT | UNSIGNED | | NO | 0 | | |
@@ -19,15 +19,15 @@ The data in this table is maintained by the core.
[2]: #acctid
[3]: #numchars
-## Description of the fields
+**Description of the fields**
### realmid
-The ID of the realm. See [realmlist.id](realmlist#id)
+The ID of the realm. See [realmlist.id](realmlist#id).
### acctid
-The account ID. See [account.id](account#id)
+The account ID. See [account.id](account#id).
### numchars
diff --git a/docs/realmlist.md b/docs/realmlist.md
index 3359631..97c8a8c 100644
--- a/docs/realmlist.md
+++ b/docs/realmlist.md
@@ -9,18 +9,18 @@ This table sets up information on all available realms. Each row controls a diff
**Structure**
| Field | Type | Attributes | Key | Null | Default | Extra | Comment |
-|----------------------------|--------------|------------|-----|------|---------------|----------------|---------|
+| -------------------------- | ------------ | ---------- | --- | ---- | ------------- | -------------- | ------- |
| [id][1] | INT | UNSIGNED | PRI | NO | | AUTO_INCREMENT | |
-| [name][2] | VARCHAR(32) | | UNI | NO | '' | | |
-| [address][3] | VARCHAR(255) | | | NO | 127.0.0.1 | | |
-| [localAddress][4] | VARCHAR(255) | | | NO | 127.0.0.1 | | |
-| [localSubnetMask][5] | VARCHAR(255) | | | NO | 255.255.255.0 | | |
+| [name][2] | VARCHAR(32) | SIGNED | UNI | NO | '' | | |
+| [address][3] | VARCHAR(255) | SIGNED | | NO | 127.0.0.1 | | |
+| [localAddress][4] | VARCHAR(255) | SIGNED | | NO | 127.0.0.1 | | |
+| [localSubnetMask][5] | VARCHAR(255) | SIGNED | | NO | 255.255.255.0 | | |
| [port][6] | SMALLINT | UNSIGNED | | NO | 8085 | | |
| [icon][7] | TINYINT | UNSIGNED | | NO | 0 | | |
| [flag][8] | TINYINT | UNSIGNED | | NO | 2 | | |
| [timezone][9] | TINYINT | UNSIGNED | | NO | 0 | | |
| [allowedSecurityLevel][10] | TINYINT | UNSIGNED | | NO | 0 | | |
-| [population][11] | FLOAT | | | NO | 0 | | |
+| [population][11] | FLOAT | SIGNED | | NO | 0 | | |
| [gamebuild][12] | INT | UNSIGNED | | NO | 12340 | | |
[1]: #id
@@ -66,7 +66,7 @@ The port that the world server is running on. If all world servers are on the sa
The icon of the realm.
| Icon | Type |
-|------|--------|
+| ---- | ------ |
| 0 | Normal |
| 1 | PvP |
| 4 | Normal |
@@ -78,7 +78,7 @@ The icon of the realm.
Realmflag of this realm.
| Flag | Hex value | Description |
-|------|-----------|--------------|
+| ---- | --------- | ------------ |
| 0 | 0x0 | None |
| 1 | 0x1 | Invalid |
| 2 | 0x2 | Offline |
@@ -91,10 +91,10 @@ Realmflag of this realm.
### timezone
-The realm timezone, it will be displayed in the tabs of the realmlist
+The realm timezone, it will be displayed in the tabs of the realmlist.
| timezone | displayed name |
-|----------|--------------------|
+| -------- | ------------------ |
| 1 | Development |
| 2 | United States |
| 3 | Oceanic |
@@ -167,7 +167,7 @@ This field is automatically updated at regular intervals and will have the curre
Accepted Client version for the realm.
| Build Version | Client Patch |
-|---------------|--------------|
+| ------------- | ------------ |
| 5875 | 1.12.1 |
| 6005 | 1.12.2 |
| 8606 | 2.4.3 |
diff --git a/docs/secret_digest.md b/docs/secret_digest.md
index 64c0396..9b3d756 100644
--- a/docs/secret_digest.md
+++ b/docs/secret_digest.md
@@ -1,21 +1,19 @@
-# secret_digest
+# secret\_digest
[<-Back-to:Auth](database-auth.md)
-**The \`secret_digest\` table**
+**The \`secret\_digest\` table**
**Structure**
| Field | Type | Attributes | Key | Null | Default | Extra | Comment |
| ------------ | ------------ | ---------- | --- | ---- | ------- | ----- | ------- |
| [id][1] | INT | UNSIGNED | PRI | NO | | | |
-| [digest][2] | VARCHAR(100) | | | NO | | | |
-
+| [digest][2] | VARCHAR(100) | SIGNED | | NO | | | |
[1]: #id
[2]: #digest
-
**Description of the fields**
### id
@@ -24,4 +22,4 @@ The id digest.
### digest
-`field-no-description|2` \ No newline at end of file
+`field-no-description|2`
diff --git a/docs/uptime.md b/docs/uptime.md
index 395732d..8dd6dfa 100644
--- a/docs/uptime.md
+++ b/docs/uptime.md
@@ -9,12 +9,12 @@ This table holds the server's uptime. The core will automatically update the lat
**Structure**
| Field | Type | Attributes | Key | Null | Default | Extra | Comment |
-|-----------------|--------------|------------|-----|------|-------------|-------|---------|
+| --------------- | ------------ | ---------- | --- | ---- | ----------- | ----- | ------- |
| [realmid][1] | INT | UNSIGNED | PRI | NO | | | |
| [starttime][2] | INT | UNSIGNED | PRI | NO | 0 | | |
| [uptime][3] | INT | UNSIGNED | | NO | 0 | | |
| [maxplayers][4] | SMALLINT | UNSIGNED | | NO | 0 | | |
-| [revision][5] | VARCHAR(255) | | | NO | AzerothCore | | |
+| [revision][5] | VARCHAR(255) | SIGNED | | NO | AzerothCore | | |
[1]: #realmid
[2]: #starttime
@@ -26,7 +26,7 @@ This table holds the server's uptime. The core will automatically update the lat
### realmid
-The ID of the realm. See [realmlist.id](realmlist#id)
+The ID of the realm. See [realmlist.id](realmlist#id).
### starttime
@@ -42,4 +42,4 @@ The maximum number of players connected.
### revision
-The detailed revision of the worldserver
+The detailed revision of the worldserver.
diff --git a/docs/version_db_auth.md b/docs/version_db_auth.md
index 2bb9da7..d78d46b 100644
--- a/docs/version_db_auth.md
+++ b/docs/version_db_auth.md
@@ -1,15 +1,15 @@
-# version_db_auth
+# version\_db\_auth
[<-Back-to:Auth](database-auth.md)
-**The \`version_db_auth\` table**
+**The \`version\_db\_auth\` table**
| Field | Type | Attributes | Key | Null | Default | Extra | Comment |
-|--------------------|--------------|------------|-----|------|---------|-------|---------|
-| [sql_rev][1] | VARCHAR(100) | | PRI | NO | | | |
-| [required_rev][2] | VARCHAR(100) | | MUL | YES | | | |
-| [date][3] | VARCHAR(50) | | | YES | | | |
-| [2021_06_17_00][4] | BIT(1) | | | YES | | | |
+| ------------------ | ------------ | ---------- | --- | ---- | ------- | ----- | ------- |
+| [sql_rev][1] | VARCHAR(100) | SIGNED | PRI | NO | | | |
+| [required_rev][2] | VARCHAR(100) | SIGNED | MUL | YES | | | |
+| [date][3] | VARCHAR(50) | SIGNED | | YES | | | |
+| [2021_06_17_00][4] | BIT(1) | SIGNED | | YES | | | |
[1]: #sqlrev
[2]: #requiredrev
@@ -18,19 +18,18 @@
**Description of the fields**
-### sql_rev
+### sql\_rev
SQL review.
-### required_rev
+### required\_rev
### date
Sql revisions date.
-### 2021_06_17_00
+### 2021\_06\_17\_00
The date of the last update to the auth database.
**Note** this column changes automatically according to the last update of the auth database.
-
generated by cgit (git 2.34.1) at 2026-05-15 23:19:37 +0000