Skip to content

docs: Update secrets in README #30

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Oct 8, 2025
Merged

docs: Update secrets in README #30

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f371861
docs: Update secrets in README
derrix060 Aug 22, 2025
6f89bc1
fix: enhance warning message for missing config file to include file …
derrix060 Aug 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,8 @@ To make setting environment variables easier there is a `.env.example` file in t
| -------------|------------- |
| `REDIS_HOST` | Required for the local persistence layer operation. If not provided the setup will fallback to the default Redis instance which should be running on localhost or 127.0.0.1 if ran with the provided docker compose setup. |
| `REDIS_PASSWORD` | Required for the local persistence layer operation. If not provided the setup will fallback to the default Redis password. |
| `PRIVATE_KEY` | Used to make payments in LINK for the Data Streams verifications on-chain and for writing data on-chain on the user provided custom contract. This account will be used to pay for the transaction fees in the respective native currency for the target chain specified. |
| `PRIVATE_KEY_EVM` | Used to make payments in LINK for the EVM Data Streams verifications on-chain and for writing data on-chain on the user provided custom contract. This account will be used to pay for the transaction fees in the respective native currency for the target chain specified. |
| `SECRET_KEY_SVM` | Used to make payments in LINK for the SVM Data Streams verifications on-chain and for writing data on-chain on the user provided custom contract. This account will be used to pay for the transaction fees in the respective native currency for the target chain specified. |
| `DATASTREAMS_HOSTNAME` | Chainlink Data Streams Hostname **with protocol prefix** `https://`. Ex.: `https://api.testnet-dataengine.chain.link` |
| `DATASTREAMS_WS_HOSTNAME` | WebSocket Hostname for Data Streams **with protocol prefix** `wss://`. Ex.: `wss://ws.testnet-dataengine.chain.link` |
| `DATASTREAMS_CLIENT_ID` | Client ID for authentication. |
Expand Down
2 changes: 1 addition & 1 deletion server/config/config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ export const config: Config = (() => {
try {
return load(readFileSync(CONFIG_PATH, 'utf8')) as Config;
} catch {
logger.warn('⚠️ No config file provided - proceeding with empty config.');
logger.warn(`⚠️ No config file provided in ${CONFIG_PATH} - proceeding with empty config.`);
return {} as Config;
}
})();