[docs]: Incomplete setup instructions for running the Unkey API locally

[Nelwhix]

Type of documentation issue

Missing Information

Describe the problem and the proposed solution

On https://www.unkey.com/docs/contributing/getting-started. After following up the steps to set up the api and run it, I got this error when I made a request:

{
  "message": "BAD_ENVIRONMENT",
  "errors": [
    {
      "code": "invalid_type",
      "expected": "string",
      "received": "undefined",
      "path": ["AGENT_URL"],
      "message": "Required"
    },
    {
      "code": "invalid_type",
      "expected": "string",
      "received": "undefined",
      "path": ["AGENT_TOKEN"],
      "message": "Required"
    },
    {
      "code": "invalid_type",
      "expected": "string",
      "received": "undefined",
      "path": ["CLICKHOUSE_URL"],
      "message": "Required"
    }
  ]
}

so the API section should have

The API runs on workerd, thus you need to populate apps/api/.dev.vars instead of .env with the same values as above.

DATABASE_HOST=aws.connect.psdb.cloud
DATABASE_USERNAME=...
DATABASE_PASSWORD=pscale_pw_....
AGENT_URL="http://localhost:8080"
AGENT_TOKEN="agent-auth-secret"
CLICKHOUSE_URL="http://default:password@localhost:8123"

This seems obvious in hind-sight, but I was stuck at first on what key to use as my bearer token. So maybe I could add a section in the docs explaining that. Also apps/api/.dev.vars.example should be updated with the AGENT_URL, AGENT_TOKEN and CLICKHOUSE_URL variables.

If you think this is a good change, I can start working on a fix immediately.

[linear]

ENG-1625 [docs]: Incomplete setup instructions for running the Unkey API locally