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 configuration.md #1663

Merged
merged 8 commits into from
Apr 9, 2023
Merged

update configuration.md #1663

merged 8 commits into from
Apr 9, 2023

Conversation

ballPointPenguin
Copy link
Contributor

@ballPointPenguin ballPointPenguin commented Mar 29, 2023

Added the new docs/upgrading.md guide.
Detail every env var in docs/configuration.md.

Change the new STATIC_FILES_CLIENT_PORT to STATIC_FILES_PARTICIPATION_PORT

docs/configuration.md Outdated Show resolved Hide resolved
docs/configuration.md Outdated Show resolved Hide resolved
@metasoarous
Copy link
Member

Line notes aside, there's two things I'd like to see:

  • MONO_STYLE for environment variables (though BOLD_MONO would be great!)
  • A section either here or in CHANGELOG on upgrading for existing deployments

I'll take a closer look at tomorrow hopefully.

Thanks!

docs/configuration.md Outdated Show resolved Hide resolved
@@ -38,7 +38,7 @@ get very far. Still it can be useful for developing and debugging builds.

The folowing environment variable can be set when building and running this application. If using the top-level `docker compose` configuration, it can be found in the `.env` file there.

**SERVICE_URL**: (Optional) The URL of your API Server. Set this value if your API Server is not on the same domain as your client-report.
**`SERVICE_URL`**: (Optional) The URL of your API Server. Set this value if your API Server is not on the same domain as your client-report.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this actually be REPORT_SERVICE_URL? See #1666.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would still like clarification on this, but not blocking for now.

@xeeg xeeg added this to the Hugo milestone Apr 6, 2023
@xeeg xeeg added the P3 label Apr 6, 2023

Values that have been renamed or replaced:

- **`DATABASE_FOR_READS_NAME`** has been replaced by **`READ_ONLY_DATABASE_URL`**
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ballPointPenguin This is somewhat problematic with usage on Heroku, since the main DATABASE_URL (and any read replica dbs) needs to be managed by the system. That's why we implemented DATABASE_FOR_READS_NAME as a pointer to the var that gets read from for the read only database.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lets fork this off as a separate issue

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

docs/configuration.md Outdated Show resolved Hide resolved
docs/configuration.md Outdated Show resolved Hide resolved
server/src/config.ts Outdated Show resolved Hide resolved
@metasoarous metasoarous merged commit 6daa2d6 into edge Apr 9, 2023
@ballPointPenguin ballPointPenguin deleted the br/config-documentation branch April 9, 2023 21:10
metasoarous added a commit that referenced this pull request Apr 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants