LPD-18031: Add documentation because we migrate from *.localhost to *.test

As we're updating our development environment to Ubuntu 24.04, the *.localhost domains are resolved differently, which caused oAuth to break. To solve this, we migrate our local domains to *.test.

Author: josephineb

README.md

@@ -7,7 +7,7 @@
 The Docker Compose file in this repository contains an instance of
 [Traefik](https://traefik.io/) for development purposes. It allows you to access
 microservices through your browser using a hostname (such as
-`accounts.leviy.localhost`) and to run multiple microservices at the same time
+`accounts.leviy.test`) and to run multiple microservices at the same time
 without port binding conflicts.
 
 ## Getting started
@@ -16,7 +16,7 @@ without port binding conflicts.
 
 - [Docker](https://docs.docker.com/install/)
 - [Docker Compose](https://docs.docker.com/compose/)
-- A DNS resolver that resolves any hostname ending in ".localhost" to 127.0.0.1 (see [instructions](docs/dns.md))
+- A DNS resolver that resolves any hostname ending in ".test" to 127.0.0.1 (see [instructions](docs/dns.md))
 
 ### Installation
 
@@ -51,7 +51,7 @@ services:
       - workspace
       - default
     labels:
-      traefik.frontend.rule: Host:subdomain.leviy.localhost
+      traefik.frontend.rule: Host:subdomain.leviy.test
       traefik.enable: 'true'
 
 networks:
@@ -67,5 +67,5 @@ Non-web services (such as databases, etc.) should only be linked to the
 
 When started, Traefik will automatically detect this service and start routing
 traffic to it.
-To see it in action simply open `http://subdomain.leviy.localhost` in a
+To see it in action simply open `http://subdomain.leviy.test` in a
 browser.

docs/dns.md

@@ -8,41 +8,37 @@ host you need to configure your DNS to resolve all hostnames ending on
 
 ## Linux (Ubuntu)
 
-On Ubuntu 18.04 no action is required, because [systemd-resolved](https://manpages.ubuntu.com/manpages/bionic/man8/systemd-resolved.service.8.html)
-already resolves hostnames ending on ".localhost" to 127.0.0.1 and ::1.
+On Ubuntu 20.04 you have to manually add lines to the /etc/hosts file for all domains that
+you want to resolve locally:
 
-If for some reason resolving is not working on Ubuntu, make sure that the
-symlink `/etc/resolv.conf` is pointing to `/run/systemd/resolve/stub-resolv.conf`:
-
-```bash
-ll /etc/resolv.conf
+```
+127.0.0.1	dashboard.leviy.test
+127.0.0.1	files.leviy.test
+127.0.0.1	accounts.leviy.test
 ```
 
-If this doesn't point to `/run/systemd/resolve/stub-resolv.conf`, overwrite the
-symbolic link:
+On Ubuntu 24.04 you can use the `systemd-resolve` to resolve all domains ending on ".test" to 127.0.0.1.
 
-```bash
-sudo ln -sf /run/systemd/resolve/stub-resolv.conf /etc/resolv.conf
-```
+(work in progress, will add additional instructions as soon as we updated to Ubuntu 24.04)
 
 ## macOS High Sierra
 
 On macOS the same can be achieved by installing dnsmasq and configuring it to
-route all traffic for ".localhost" to 127.0.0.1:
+route all traffic for ".test" to 127.0.0.1:
 
 ```bash
 brew install dnsmasq
 
 mkdir -pv $(brew --prefix)/etc/
-echo 'address=/.localhost/127.0.0.1' >> $(brew --prefix)/etc/dnsmasq.conf
+echo 'address=/.test/127.0.0.1' >> $(brew --prefix)/etc/dnsmasq.conf
 echo 'port=53' >> $(brew --prefix)/etc/dnsmasq.conf
 
 sudo brew services start dnsmasq
 
 sudo mkdir -v /etc/resolver
 sudo bash -c 'echo "nameserver 127.0.0.1" > /etc/resolver/localhost'
 
-ping dashboard.leviy.localhost
+ping dashboard.leviy.test
 ```
 
 [Source](https://medium.com/@kharysharpe/automatic-local-domains-setting-up-dnsmasq-for-macos-high-sierra-using-homebrew-caf767157e43)