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

docs: Add configuration details to README #5

Merged
merged 2 commits into from
Jan 10, 2025
Merged
Changes from all commits
Commits
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
38 changes: 38 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,44 @@ contributoor config # View/edit configuration
contributoor update # Update the service to the latest version
```

## Configuration

The [contributoor-installer](https://github.com/ethpandaops/contributoor-installer) will generate a `config.yaml` file for you.

```yaml
# The address of your beacon node's HTTP API.
beaconNodeAddress: http://127.0.0.1:64692

# The address of your metrics server (defaults to :9090).
metricsAddress: ":9090"

# The log level (debug, info, warn, error).
logLevel: info

# The network name (NETWORK_NAME_MAINNET, NETWORK_NAME_SEPOLIA, NETWORK_NAME_HOLESKY).
networkName: NETWORK_NAME_MAINNET

# The output server configuration (credentials are base64 encoded and required if a pandaops server is used).
outputServer:
address: https://xatu.primary.production.platform.ethpandaops.io
credentials: YWRtaW46YWRtaW4=

# The contributoor version to use.
version: 0.0.8

# The directory where contributoor stores its configuration and data.
contributoorDirectory: /Users/username/.contributoor

# The method to run contributoor (RUN_METHOD_DOCKER, RUN_METHOD_BINARY, RUN_METHOD_SYSTEMD).
runMethod: RUN_METHOD_DOCKER
```

If you encounter configuration issues, you can:

1. Compare your config with the example above
2. Remove the config file and re-run `contributoor install` to generate a fresh one
3. Check the debug logs for detailed error messages

## Development

### Running Locally
Expand Down
Loading