Conversation
|
@ChrisSchinnerl , the issue mentions you want to get rid of
|
There was a problem hiding this comment.
Pull request overview
Adds a full project README to document what s3d is, how to build/run it, and its S3 feature coverage.
Changes:
- Expanded README with overview, build instructions, and getting-started flow
- Added Docker compose example and configuration reference (flags/paths/env vars)
- Documented multipart uploads and an S3 compatibility matrix
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| The following environment variables may be used to override the default | ||
| configuration and take precedence over the config file settings. | ||
|
|
||
| | Variable | Description | | ||
| |----------|-------------| | ||
| | `S3D_CONFIG_FILE` | Override the config file path | | ||
| | `S3D_DATA_DIR` | Override the data directory | | ||
| | `S3D_RECOVERY_PHRASE` | Set the wallet recovery phrase | |
There was a problem hiding this comment.
The text says environment variables “take precedence over the config file settings”, but LoadFile decodes YAML directly into cfg, which will overwrite values initially sourced from S3D_DATA_DIR/S3D_RECOVERY_PHRASE in main.go. Please reword this section to match actual precedence (env vars mainly affect default values / config path selection).
| The following environment variables may be used to override the default | |
| configuration and take precedence over the config file settings. | |
| | Variable | Description | | |
| |----------|-------------| | |
| | `S3D_CONFIG_FILE` | Override the config file path | | |
| | `S3D_DATA_DIR` | Override the data directory | | |
| | `S3D_RECOVERY_PHRASE` | Set the wallet recovery phrase | | |
| The following environment variables may be used to select the config file path | |
| or provide default values before the config file is loaded. If the config file | |
| also sets `directory` or `recoveryPhrase`, those file settings take precedence. | |
| | Variable | Description | | |
| |----------|-------------| | |
| | `S3D_CONFIG_FILE` | Override the path of the config file to load | | |
| | `S3D_DATA_DIR` | Set the default data directory if not specified in the config file | | |
| | `S3D_RECOVERY_PHRASE` | Set the default wallet recovery phrase if not specified in the config file | |
There was a problem hiding this comment.
I think we should probably change this so env variables take precedence over the config file... cc @ChrisSchinnerl
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated 2 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated 2 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This PR adds a README
Close #113