-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: Update README with installation and usage instructions
- Loading branch information
Showing
1 changed file
with
67 additions
and
0 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
# Contributoor | ||
|
||
Contributoor is a lightweight service that runs alongside an Ethereum consensus client and collects data via the client's APIs. It's a streamlined, user-friendly extraction of the `sentry` service from [ethpandaops/xatu](https://github.com/ethpandaops/xatu). | ||
|
||
## Installation | ||
|
||
See the [contributoor-installer](https://github.com/ethpandaops/contributoor-installer) repository for supported platforms and installation instructions. | ||
|
||
There are three ways to install Contributoor: | ||
|
||
1. **Docker (Recommended)** | ||
- Provides the most consistent environment | ||
- Easy to update and maintain | ||
|
||
2. **Systemd/Launchd** | ||
- Native system service integration | ||
- Automatic startup on boot | ||
|
||
3. **Binary (for development)** | ||
- Direct execution | ||
- Minimal dependencies | ||
|
||
## Getting Started | ||
|
||
Once installed, you can manage the Contributoor service using these commands: | ||
|
||
```bash | ||
contributoor start # Start the service | ||
contributoor stop # Stop the service | ||
contributoor status # Check service status | ||
contributoor restart # Restart the service | ||
contributoor config # View/edit configuration | ||
contributoor update # Update the service to the latest version | ||
``` | ||
|
||
## Development | ||
|
||
### Running Locally | ||
|
||
To run Contributoor in development mode: | ||
|
||
```bash | ||
go run ./cmd/sentry/main.go --config /path/to/.contributoor/config.yaml --debug true | ||
``` | ||
|
||
The `config.yaml` would have been generated for you by the installer. | ||
|
||
### Code Generation | ||
|
||
Generate protocol buffers and other generated code: | ||
|
||
```bash | ||
go generate ./... | ||
make proto | ||
``` | ||
|
||
### Testing | ||
|
||
Run tests with race detection, coverage reporting, and view the coverage report: | ||
|
||
```bash | ||
go test -race -failfast -cover -coverpkg=./... -coverprofile=coverage.out ./... && go tool cover -html=coverage.out | ||
``` | ||
|
||
## Contributing | ||
|
||
Contributoor is part of EthPandaOps' suite of tools for Ethereum network operations. Contributions are welcome! Please check our [GitHub repository](https://github.com/ethpandaops) for more information. |