diff --git a/docker-compose.example.yml b/docker-compose.example.yml index 28ad4bf2..65b46d27 100644 --- a/docker-compose.example.yml +++ b/docker-compose.example.yml @@ -9,10 +9,10 @@ services: # Commented out variables are optional # Your Golbat or RDM database - SCANNER_DB_URL: "mysql://rdm_user:rdm_password@host:3306/rdm_database" + SCANNER_DB_URL: "mysql://golbat_user:golbat_password@host:3306/golbat_database" - # Your Dragonite (if using) or RDM database (if you're using a hybrid Golbat/RDM setup) - # CONTROLLER_DB_URL: 'mysql://dragonite_user:dragonite_password@host:3306/dragonite_database' + # Your Dragonite or RDM database (if you're using a hybrid Golbat/RDM setup) + CONTROLLER_DB_URL: 'mysql://dragonite_user:dragonite_password@host:3306/dragonite_database' # Your Koji database KOJI_DB_URL: "mysql://koji_user:koji_password@127.0.0.1:3306/koji_database" diff --git a/docs/pages/integrations.mdx b/docs/pages/integrations.mdx index 45c5c40b..16d6b4f8 100644 --- a/docs/pages/integrations.mdx +++ b/docs/pages/integrations.mdx @@ -24,6 +24,15 @@ In Kōji's architecture, various external integrations primarily leverage HTTP ` You can use unique project names for Multi-Domain setups! +### Project setup + +This is configured inside your Kōji `/admin/project` and will allow hot reloading of your areas within ReactMap. + +```yml +API Endpoint: http://{reactmap_ip}:{port}/api/v1/area/reload +API Key: react-map-secret:{config.api.reactMapSecret} +``` + ### Supported Features - Polygons ✅ @@ -33,7 +42,7 @@ In Kōji's architecture, various external integrations primarily leverage HTTP ` ## PoracleJS -- Remove the need to have a `geofence.json` file by loading your managed geofences straight from Kōji +- Remove the need to have a `geofence.json` file by loading your managed geofences straight from Kōji. - You must set two config values to use Kōji with Poracle 1. First set your Kōji Bearer Token: @@ -77,6 +86,15 @@ API Key: X-Poracle-Secret:{config.server.apiSecret} - `koji.url` - Example: `http://{koji_ip}/api/v1/geofence/feature-collection/{project_name}` +### Project setup + +This is configured inside your Kōji `/admin/project` and will allow hot reloading of your areas within Golbat. + +```yml +API Endpoint: http://{golbat_ip}:{port}/api/reload-geojson +API Key: x-golbat-secret:{golbat_config.api_secret} +``` + ### Supported Features - Polygons ✅ diff --git a/docs/pages/setup/docker.mdx b/docs/pages/setup/docker.mdx index d2328527..bfad93ea 100644 --- a/docs/pages/setup/docker.mdx +++ b/docs/pages/setup/docker.mdx @@ -20,10 +20,10 @@ services: # Commented out variables are optional # Your Golbat or RDM database - SCANNER_DB_URL: 'mysql://rdm_user:rdm_password@host:3306/rdm_database' + SCANNER_DB_URL: 'mysql://golbat_user:golbat_password@host:3306/golbat_database' - # Your Dragonite (if using) or RDM database (if you're using a hybrid Golbat/RDM setup) - # CONTROLLER_DB_URL: 'mysql://dragonite_user:dragonite_password@host:3306/dragonite_database' + # Your Dragonite or RDM database (if you're using a hybrid Golbat/RDM setup) + CONTROLLER_DB_URL: 'mysql://dragonite_user:dragonite_password@host:3306/dragonite_database' # Your Koji database KOJI_DB_URL: 'mysql://koji_user:koji_password@127.0.0.1:3306/koji_database' diff --git a/docs/pages/setup/standard.mdx b/docs/pages/setup/standard.mdx index c523d97b..d0f3a9c4 100644 --- a/docs/pages/setup/standard.mdx +++ b/docs/pages/setup/standard.mdx @@ -50,10 +50,10 @@ import { Callout } from 'nextra-theme-docs' # Commented out variables are optional # Your Golbat or RDM database - SCANNER_DB_URL='mysql://rdm_user:rdm_password@host:3306/rdm_database' + SCANNER_DB_URL='mysql://golbat_user:golbat_password@host:3306/golbat_database' - # Your Dragonite (if using) or RDM database (if you're using a hybrid Golbat/RDM setup) - # CONTROLLER_DB_URL: 'mysql://dragonite_user:dragonite_password@host:3306/dragonite_database' + # Your Dragonite or RDM database (if you're using a hybrid Golbat/RDM setup) + CONTROLLER_DB_URL: 'mysql://dragonite_user:dragonite_password@host:3306/dragonite_database' # Your Koji database KOJI_DB_URL='mysql://koji_user:koji_password@127.0.0.1:3306/koji_database'