diff --git a/crawler/README.md b/crawler/README.md index 0312570..7543720 100644 --- a/crawler/README.md +++ b/crawler/README.md @@ -1,8 +1,31 @@ # Setup +1. Instal deps: ```bash -pip install -r requirements.txt +poetry install && cp .env.sample .env ``` +2. Check `.env` if you want to customize settings for broker and db +3. run `./start.sh` + +This starts the backend + +To start the fronend: + +``` +cd frontend && cp .env.sample .env +``` +Change the `DEV_HOST` to any name you want to use to access the web interface. + +Next, setup the DNS record (e.g in your /etc/hosts) file. +This is important as auth is done via external [authentik] service that needs to redirect to a name. + +Run `./start.sh` + +This starts a Caddy proxy with correct certificates, and npm dev server. +All requests going to the frontend are forwarded to the npm server and the ones for the backed (that go to `/api/*`) are forwarded to the backend service. + +Lastly, reachout to Viktor to allowlist your `DEV_HOST` so that authentik can authorize callbacks to your host. + # Formatting