TurtIeSocks / Koji

Geofence manager and route creator
https://koji.vercel.app
MIT License
26 stars 5 forks source link

docs: Update env file and project setup. #218

Closed notheowner closed 9 months ago

notheowner commented 10 months ago

Uncomment Controller DB URL. Update Scanner DB URL default to Golbat. Add ReactMap and Golbat Project Setup for hot reloading of geofences.

vercel[bot] commented 10 months ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
koji ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 9, 2024 1:30pm
Fabio1988 commented 10 months ago

probably we should keep that file also in sync :)

https://github.com/TurtIeSocks/Koji/blob/main/docker-compose.example.yml

clburlison commented 10 months ago

I think this might be more confusing for legacy peeps.

The config options are: RDM only

      # Your Golbat or RDM database
      SCANNER_DB_URL: 'mysql://rdm_user:rdm_password@host:3306/rdm_database'

RDM + Golbat (Hybrid)

      # Your Golbat or 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://rdm_user:rdm_password@host:3306/rdm_database'

Dragonite + Golbat

      # Your Golbat or 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'

I've turned off my RDM instances so I'm not sure how Koji works if someone sets SCANNER + CONTROLLER to an RDM instance.

Now's a great time to deprecate RDM support and remove all that code. nudge Turtle 😉🙃

notheowner commented 10 months ago

I think this might be more confusing for legacy peeps.

The config options are: RDM only

      # Your Golbat or RDM database
      SCANNER_DB_URL: 'mysql://rdm_user:rdm_password@host:3306/rdm_database'

RDM + Golbat (Hybrid)

      # Your Golbat or 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://rdm_user:rdm_password@host:3306/rdm_database'

Dragonite + Golbat

      # Your Golbat or 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'

I've turned off my RDM instances so I'm not sure how Koji works if someone sets SCANNER + CONTROLLER to an RDM instance.

Now's a great time to deprecate RDM support and remove all that code. nudge Turtle 😉🙃

Yeah, I didn't touch much of the wording, because I don't know when Turtle wants to ditch remove RDM support.