Skip to content

Commit 9881321

Browse files
authored
feat: prepare docs for new auth provider config (#35)
* feat: prepare docs for new auth provider config
1 parent 432f50c commit 9881321

File tree

1 file changed

+41
-3
lines changed

1 file changed

+41
-3
lines changed

pages/docs/dragonite/config.mdx

Lines changed: 41 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,54 @@ import { Callout } from 'nextra-theme-docs'
1010

1111
```toml
1212
[general]
13-
login_delay = 0 #As of now there is no known login limit, this might change in the future.
13+
api_host = 127.0.0.1
14+
api_port = 7272
15+
stats = true #Enabled by default to write worker stats.
1416
...
1517
```
1618

1719
| Key | Default | Description |
1820
| :-- | :-- | :-- |
19-
| `login_delay` | 0 | Seconds to sleep in-between PTC authenticating with one proxy. For "unlimited" proxies we recommend setting this value to 0 or 1. |
20-
| `stats` | false | Whether raw worker stats are written to the Dragonite database. |
2121
| `api_host` | 127.0.0.1 | Host listener address for Dragonite API. |
2222
| `api_port` | 7272 | Host port address for Dragonite API. |
23+
| instance_name | "" | Display name of the instance in the admin instance selection |
24+
| `stats` | true | Whether raw worker stats are written to the Dragonite database. |
25+
26+
## Auth provider section
27+
28+
Auth provider config sections look like `[auth.<provider>]` where `<provider>` can be ptc or nk. One or both may exist and be enabled.
29+
At least one section does need to exist with an 'enable = true' entry.
30+
Without this, the deprecated config locations under general and tuning will be used with both providers enabled.
31+
32+
```toml
33+
[auth.ptc]
34+
# enable this provider (defaults to false)
35+
enable = true
36+
# The following 2 options allow control over whether a certain provider
37+
# should be used for leveling and/or scanning. Setting both to false allows
38+
# one to do background token work without yet logging into the game with them.
39+
# enable this provider for normal scanning
40+
# enable_scanning = true (defaults to true)
41+
# enable this provider for leveling
42+
# enable_leveling = true (defaults to true)
43+
44+
# seconds to sleep in-between authing on one proxy
45+
# login_delay = 20 (defaults to 20 for both providers)
46+
47+
# use swirlix/xilriws to remote auth PTC logins
48+
# remote_auth_url =
49+
# background initer to collect tokens of accounts without using them - this is false by default
50+
# token_init_enabled = true
51+
# don't rely on remote auth and only use accounts with stored token - true by default
52+
# token_refresh_only = true
53+
```
54+
55+
⚠ Additional config variables, but only put them if you know what you do ⚠
56+
| Key | Default | Description |
57+
| :-- | :-- | :-- |
58+
| token_refresh_concurrency | 10 | define concurrency for the token background refresher |
59+
| token_init_concurrency | 1 | define concurrency for the token background initer |
60+
| token_init_interval_seconds | PTC: 1, NK: 180 | define the interval to request tokens |
2361

2462
## Koji section
2563

0 commit comments

Comments
 (0)