Skip to content

Commit

Permalink
docs: Update docker setup and dragonite config (#27)
Browse files Browse the repository at this point in the history
* Update PTC login and an oopsie

* docker setup and config

* db and words

* Remove dynamic route split.

* Update tuning

* dots
  • Loading branch information
notheowner authored Jan 13, 2024
1 parent f490319 commit 74aa27a
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 17 deletions.
20 changes: 12 additions & 8 deletions pages/docs/dragonite/config.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@ import { Callout } from 'nextra-theme-docs'

```toml
[general]
login_delay = 20
login_delay = 0 #As of now there is no known login limit, this might change in the future.
...
```

| Key | Default | Description |
| :-- | :-- | :-- |
| `login_delay` | 20 | Seconds to sleep in-between PTC authenticating with one proxy. For "unlimited" proxies we recommend setting this value to 1. |
| `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. |
| `stats` | false | Whether raw worker stats are written to the Dragonite database. |
| `api_host` | 127.0.0.1 | Host listener address for Dragonite API. |
| `api_port` | 7272 | Host port address for Dragonite API. |
Expand Down Expand Up @@ -49,18 +49,22 @@ bearer_token = "KOJI_SECRET"

```toml
[tuning]
dynamic_route_split = true
...
#recycle_gmo_limit = 4900
#recycle_encounter_limit = 9900
#recycle_on_jail=false
#minimum_account_reuse_hours = 169
#location_delay = 0
#fort_location_delay = 0
```

| Key | Default | Description |
| :-- | :-- | :-- |
| `dynamic_route_split` | true | When enabled Dragonite will update the route that workers are using as they connect or disconnect from an area. |
| `recycle_gmo_limit` | 4900 | (Advanced) Recommend keeping this value commented out. When the GMO limit is reached for a specific account it will be be rotated. |
| `recycle_encounter_limit` | 9900 | (Advanced) Recommend keeping this value commented out. When an account has encountered this amount of pokemon it will be rotated. |
| `recycle_on_jail` | false | Enabling this setting will utilize significantly more accounts. Currently three accounts are assign to one worker and will rotate while the worker is running. |
| `recycle_on_jail` | false | Enabling this setting will utilize significantly more accounts. Currently five accounts are assigned to one worker and will rotate while the worker is running. |
| `location_delay` | 0 | This value, in milliseconds, will add a slight wait period while a worker is moving to a new location. Adding a slight delay has proven to decrease empty GMO results and positively impact scans overall. Recommend starting with 100, 200, 300, etc and monitoring overall results. |
| `fort_location_delay` | 0 | This value, in milliseconds, is the same as `location_delay` however it only impacts fort scans (gyms/pokestops). |
| `minimum_account_reuse_hours` | 0 | This sets the amount of hours for accounts to "rest" until they can be reused. Recommended value is 169 hours (7 days). |

## Rotom section

Expand Down Expand Up @@ -113,13 +117,13 @@ golbat_api_secret = ""

```toml
[db.dragonite]
host = "0.0.0.0"
host = "127.0.0.1"
...
```

| Key | Default | Description |
| :-- | :-- | :-- |
| `host` | "0.0.0.0" | Database host address. |
| `host` | "127.0.0.1" | Database host address. |
| `port` | 3306 | Database port address. |
| `user` | "" | Database username. |
| `password` | "" | Database password. |
Expand Down
27 changes: 18 additions & 9 deletions pages/docs/setup/docker.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import { Callout } from 'nextra-theme-docs'

## Prerequisites

- [Docker](https://docs.docker.com/engine/install/) - If you are not familiar working with Docker see [Standard Setup](https://unownhash.com/docs/setup/standard)
- [Docker](https://docs.docker.com/engine/install/) - If you are not familiar working with Docker see [Standard Setup](/docs/setup/standard)
- Compatible Database - See [Database Setup](/docs/other/database)

## Install services with Docker
Expand Down Expand Up @@ -131,26 +131,26 @@ import { Callout } from 'nextra-theme-docs'

Using Golbat's gRPC endpoint (default port 50001) is recommended over the raw endpoint (default 9001).

```toml filename="dragonite_config.toml" {2,5,7,9,11-16}
```toml filename="dragonite_config.toml" {2,5-7,9,11-16}
[rotom]
endpoint = "ws://rotom:7071"
[processors]
#golbat_endpoint = "http://golbat:9001"
golbat_endpoint = "http://golbat:9001"
golbat_raw_bearer = ""
golbat_api_secret = "golbat1234"
# if this is present then dragonite will not send raws to the httpendpoint
# if this is present then dragonite will not send raws to the httpendpoint. You still need the regular endpoint for API calls.
golbat_grpc_endpoint = "golbat:50001"
[db]
host = "0.0.0.0"
host = "db"
port = 3306
user = ""
password = ""
name = "dragonite"
```

```toml filename="golbat_config.toml" {2,4, 7-10}
```toml filename="golbat_config.toml" {1-4, 7-10}
port = 9001 # Listening port for golbat
grpc_port = 50001 # Listening port for grpc
raw_bearer = "" # Raw bearer (password) required
Expand All @@ -159,12 +159,21 @@ import { Callout } from 'nextra-theme-docs'
[database]
user = ""
password = ""
address = "127.0.0.1:3306"
db = ""
address = "db:3306"
db = "golbat"
```

It is **highly recommended** setting a secret if Rotom is accessible from the public internet.

```json filename="rotom_config.json" {3}
```json filename="rotom_config.json"
"deviceListener": {
"port": 7070,
"secret": ""
},
"controllerListener":{
"port": 7071,
"secret": ""
},
"client": {
"port": 7072,
"host": "0.0.0.0"
Expand Down

0 comments on commit 74aa27a

Please sign in to comment.