Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update (required) environment variables in docs #2975

Closed
mkurapov opened this issue Sep 16, 2024 · 7 comments · Fixed by #3042
Closed

Update (required) environment variables in docs #2975

mkurapov opened this issue Sep 16, 2024 · 7 comments · Fixed by #3042
Assignees
Labels
user-doc-priority: medium User doc priority is medium user-docs

Comments

@mkurapov
Copy link
Contributor

mkurapov commented Sep 16, 2024

Context

In the rafiki docs, we should specify which environment variables are required and which ones are not.

Backend

OPEN_PAYMENTS_URL
ILP_ADDRESS
ILP_CONNECTOR_URL
INSTANCE_NAME
AUTH_SERVER_GRANT_URL
AUTH_SERVER_INTROSPECTION_URL
WEBHOOK_URL
KEY_ID
EXCHANGE_RATES_URL
USE_TIGERBEETLE
DATABASE_URL
REDIS_URL

Auth

IDENTITY_SERVER_URL
IDENTITY_SERVER_SECRET
AUTH_SERVER_URL
COOKIE_KEY
AUTH_DATABASE_URL
REDIS_URL

Frontend

GRAPHQL_URL
OPEN_PAYMENTS_URL

@mkurapov
Copy link
Contributor Author

@melissahenderson I would recommend potentially we have these presented first and separate from the other environment variables (ie not have them in a single table). Might be clearer trying to find all of the required things off the bat.

@melissahenderson
Copy link
Contributor

This is currently in progress, but not yet in GH. I have all the env variables I can find split into google docs for auth, backend, and frontend and they are being reviewed--accuracy in naming, helm value, default value, description... So this issue will be taken care of when those reviews are complete and the environment tables in Starlight are all updated as needed.

@melissahenderson
Copy link
Contributor

#2994 is related and there will likely be other issues opened for auth and backend.

@melissahenderson melissahenderson added the user-doc-priority: medium User doc priority is medium label Sep 30, 2024
@melissahenderson
Copy link
Contributor

Auth doc is good, no further questions or issues. Frontend still reliant on #2994. Backend still has a lot of outstanding Helm issues and is missing variable descriptions.

@brad-dow
Copy link
Contributor

brad-dow commented Oct 14, 2024

New backend environment variable (not required) and associated issue: #3035

@melissahenderson
Copy link
Contributor

Added to Google Doc so it won't be overwritten in the Rafiki docs when I get to those updates.

@melissahenderson
Copy link
Contributor

PR #3042 cares for this issue; however, the PR can't be merged until #2994 is complete.

@github-project-automation github-project-automation bot moved this from Backlog to Done in Rafiki Nov 6, 2024
@github-project-automation github-project-automation bot moved this from Ready for Review to Done in Documentation Nov 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
user-doc-priority: medium User doc priority is medium user-docs
Projects
Status: Done
Status: Done
Development

Successfully merging a pull request may close this issue.

3 participants