Skip to content

Commit 566be74

Browse files
authored
feat: prepare docs for new auth provider config
1 parent 432f50c commit 566be74

File tree

1 file changed

+37
-3
lines changed

1 file changed

+37
-3
lines changed

pages/docs/dragonite/config.mdx

Lines changed: 37 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,50 @@ 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+
stats = true #Enabled by default to write worker stats.
1414
...
1515
```
1616

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

2458
## Koji section
2559

0 commit comments

Comments
 (0)