bumper/docs/DNS_Setup.md
Brian Martin d2ebe12145 Split README into docs
Splitting README into docs to make it shorter and easier to maintain.

- Change to os_db_path adding createdir so tests can skip creation of the path
2019-05-30 09:13:19 -04:00

1.8 KiB

DNS

You need to configure your router to point DNS locally to where Bumper is running.
The easiest way is overriding the main domains used by EcoVacs using DNSMasq/PiHole, by adding address entries in a custom config.

Custom DNSMasq Config

Typically written at /etc/dnsmasq.d/{##}-{name}.conf - Ex: /etc/dnsmasq.d/02-custom.conf

File Contents:

address=/ecouser.net/{bumper server ip}
address=/ecovacs.com/{bumper server ip}
address=/ecovacs.net/{bumper server ip}

Note: Replace {bumper server ip} with your server's IP

If using PiHole, reload FTL to apply changes: sudo service pihole-FTL reload

Manual Override

If overriding DNS for the top-level domains isn't an option, you'll need to configure your router DNS to point a number of domains used by the app/robot to the Bumper server.

Note: Depending on country, your phone/robot may be using a different domain. Most of these domains contain country-specific placeholders.

Not all domains have been documented at this point, and this list will be updated as more are identified/seen. The preferred way to ensure Bumper works is to override the full domains as above.

  • Example: If you see eco-{countrycode}-api.ecovacs.com and you live in the US/North America you would use: eco-us-api.ecovacs.com
Address Description
lb-{countrycode}.ecovacs.net Load-balancer that is checked by the app/robot
eco-{countrycode}-api.ecovacs.com Used for Login
portal-{countrycode}.ecouser.net Used for Login and Rest API
portal-ww.ecouser.net Used for various Rest APIs
msg-{countrycode}.ecouser.net Used for XMPP
mq-ww.ecouser.net Used for MQTT
gl-{countrycode}-api.ecovacs.com Used by Ecovacs Home app for API
recommender.ecovacs.com Used by Ecovacs Home app