Skip to content

Commit

Permalink
docs: Clarify steps for new users (#15)
Browse files Browse the repository at this point in the history
- Highlight the RDM Hybrid Setup on many pages
- Callout Flygon/Golbat endpoint for MITM clients
- Put database & services inside docker network. Makes things "just work" and likely best pratice for most users with limited docker knowledge.
  • Loading branch information
clburlison authored Jul 27, 2023
1 parent 6f0a057 commit ead0402
Show file tree
Hide file tree
Showing 6 changed files with 34 additions and 19 deletions.
2 changes: 1 addition & 1 deletion pages/docs/index.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Intro

There are two install paths, Docker or Standard. Both options provide an easy and supported way to build your environment. Docker is recommended as it is a little easier to get started, with the only downside being the _"docker abstraction layer"_. Standard setup is better if you plan on developing or testing pull requests. Just be warned, setup is a lengthier process.
There are two install paths, Docker or Standard. Both options provide an easy and supported way to build your environment. Docker is a little easier to get started, with the only downside being the _"docker abstraction layer"_. Standard setup is better if you plan on developing or testing pull requests. Just be warned, setup is a lengthier process.

- [Docker](/docs/setup/docker)
- [Standard](/docs/setup/standard)
4 changes: 4 additions & 0 deletions pages/docs/other/database.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,10 @@ services:
volumes:
data:
driver: local

networks:
default:
name: scanner
```
Once the service is up, you will need to connect to the database service with [TablePlus](https://tableplus.com/), [Workbench](https://www.mysql.com/products/workbench/), Command Line, etc.
Expand Down
10 changes: 8 additions & 2 deletions pages/docs/setup/docker.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
import { Callout } from 'nextra-theme-docs'

# Docker Setup (recommended)
# Docker Setup

<Callout type="warning" emoji="⚠️">
Some of these steps will fail since Flygon is not public yet!
Flygon is not public yet!

If you wish to continue the setup process make sure to comment out or delete the Flygon service. The [Hybrid Setup](/docs/other/hybrid-setup) will allow you to continue using RealDeviceMap (RDM) to control your devices while sending data to Golbat for processing.
</Callout>

## Prerequisites
Expand Down Expand Up @@ -72,6 +74,10 @@ import { Callout } from 'nextra-theme-docs'
ADMIN_GOLBAT_API_SECRET: secret
ports:
- "9003:9003" # change left one for external port

networks:
default:
name: scanner
```
<Callout type="info" emoji="ℹ️">
Expand Down
18 changes: 10 additions & 8 deletions pages/docs/setup/next-steps.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@ import { Callout } from 'nextra-theme-docs'

# Next Steps

<Callout type="info" emoji="🚧">
This page is still under construction
</Callout>

This guide walks you through what to do after you have completed the Docker or Standard setup process. You have things running but now what?

## Setup RDM Raw Reflection

The [Hybrid Setup](/docs/other/hybrid-setup) will allow you to continue using RealDeviceMap (RDM) to control your devices while sending data to Golbat for processing.

## Configure Koji

I know you want me to go setup _yet another_ thing but this is important as Koji helps you visualize and create routes. This will save time down the road. Go check out the [Koji Docs](https://koji.vercel.app).
Expand All @@ -16,9 +16,11 @@ Now that you have configured the service go modify your **Golbat** and **Flygon*

## Modify MITM client

Point your MITM clients to `http://YOUR_IP:9002/` (assuming default port).

<Callout type="info" emoji="ℹ️">
For [DeviceConfigManager](https://github.com/versx/deviceconfigmanager) this
same URI should be used for both Backend & Data Endpoint.
If you are using RDM Raw Mirroring you can skip this section.
</Callout>

Now that services are configured you need to configure devices to send data requests to the correct endpoint. Some MITM clients only allow one endpoint (Atlas) so Flygon can be used to receive all data and then forward the `/raw` data to Golbat.

- If sending data to Flygon use `http://YOUR_IP:9002/` (assuming default port).
- If sending data to Golbat you can use `http://YOUR_IP:9001/raw` (assuming default port).
4 changes: 3 additions & 1 deletion pages/docs/setup/standard.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@ import { Callout } from 'nextra-theme-docs'
# Standard

<Callout type="warning" emoji="⚠️">
Some of these steps will fail since Flygon is not public yet!
Flygon is not public yet!

If you wish to continue the setup process you can skip the Flygon install, build, and run steps. The [Hybrid Setup](/docs/other/hybrid-setup) will allow you to continue using RealDeviceMap (RDM) to control your devices while sending data to Golbat for processing.
</Callout>

## Prerequisites
Expand Down
15 changes: 8 additions & 7 deletions pages/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,16 @@ Each service is incredibly customizable and highly optimized. The services are w
Some of our highlighted features:

- Advanced Ditto detection
- Advanced IV, shiny, hundo, & nundo statistics
- Gym
- Gym parsing
- In Memory Pokemon Cache
- Invasions
- Pokemon
- Pokestop
- Invasions line-up parsing
- IV, shiny, hundo, & nundo statistics
- Pokemon parsing
- Pokestop parsing
- PVP calculation
- Quest
- Webhook
- Quest parsing
- Routes parsing
- Webhook processing
- and more!

## Still interested?
Expand Down

0 comments on commit ead0402

Please sign in to comment.