OpenFn / OpenFn/apollo

Cannot setup local auth if POSTGRES_URL is not set

Open
#593 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Jupyter Notebook
Stars
5
Forks
10
Avg merge
2d 20h
Merged PRs (30d)
17

Description

To connect apollo to Lightning, one need to configure a database URL to write the clients table to.

The example env sets POSTGRES_URL which is fine.

If users have no set up .env (and I'm not sure they're told to in the readme?) then auth will fail. There is no default set.

Should we default the db to apollo_dev? Should we default to lightning_dev? Are docs clear? Is it correct that there's no default so that we're not writing to a random database?

See also https://github.com/OpenFn/apollo/issues/579

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by checking the example environment configuration and README to see how local auth is expected to provide POSTGRES_URL. Trace the local auth database setup, then resolve whether a safe default should be used or the required configuration should be documented; done means the chosen behavior is clear and local auth setup no longer fails unexpectedly.

Written by the indexing model from the issue text.

Assessment

Tech stack
postgres
Domain
authentication, databases
Issue type
Bug
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.