Chore: Update README #528
Open
Chore: Update README #528
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add a more concrete example to change the SALESFORCE_* env var in the config file
Current instruction is not working due to SSL verification error ssl:true option is needed on the config file to bypass such error in the DB connection string
asugar13
reviewed
Jan 15, 2025
| ```yaml | ||
| DB: | ||
| host: "DATABASE_HOST_DOCKER" # DATABASE_HOST | ||
| ``` | ||
|
|
||
| ### Running the API |
There was a problem hiding this comment.
Nitpick: I think we should stop mentioning the .env file on line 87 as we noticed that this needs to be on doppler instead.
There was a problem hiding this comment.
I thought we still need to edit the .env for next-router. Just checked Doppler and all the syn- env var are available. Will update this part.
asugar13
reviewed
Jan 15, 2025
| @@ -78,7 +87,12 @@ You MIGHT need: | |||
|
|
|||
| If you need to use the database locally, set up the database by following the instructions in [next-syndication-db-schema](https://github.com/Financial-Times/next-syndication-db-schema). | |||
|
|
|||
| If you are using postgres in Docker, you will need to edit your `.env` file to set `DATABASE_HOST` to `192.168.99.100` | |||
| If you are using postgres in Docker, you will need to edit your `custom-environment-variables.yaml` file to change `DATABASE_HOST` to `DATABASE_HOST_DOCKER` (variable already defined in Doppler). | |||
There was a problem hiding this comment.
Thought: Thanks for adding these docs. I wonder if anyone ever ran postgres in Docker to run syndication 😅
There was a problem hiding this comment.
I doubt that too. In the README of next-syndication-db-schema it mentions setting up the Postgres DB in Docker (or tried to, since that section is empty 🤷), so I supposed someone might want to run the DB in Docker.
next-router uses Doppler to store its env var and all the syn- env var are available in the dev environment in Doppler, so it is good to update those
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Currently some of the instructions in README use
.envinstead of Doppler and is not working. In addition it lacks some crucial details to connect to the production DB. This PR updates those instructions so others can properly set up a working local environment for the syndication API.