Skip to content

chore: fix configuration table in the readme #28

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
echobt merged 1 commit into from
Jan 9, 2026
Merged

chore: fix configuration table in the readme #28

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 19 additions & 19 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -394,31 +394,31 @@ Standard REST endpoints for submissions, evaluations, and challenges.

### WebSocket Endpoints

| Endpoint | Description |
| ---------------------------------- | --------------------------------- |
| `/ws` | Validator events |
| `/ws/challenge` | Challenge container events |
| Endpoint | Description |
| --------------- | -------------------------- |
| `/ws` | Validator events |
| `/ws/challenge` | Challenge container events |

### Bridge Proxy

| Endpoint | Description |
| ---------------------------------- | --------------------------------- |
| `/api/v1/bridge/{challenge_id}/*` | Proxy to challenge containers |
| Endpoint | Description |
| --------------------------------- | ----------------------------- |
| `/api/v1/bridge/{challenge_id}/*` | Proxy to challenge containers |

## Configuration

| Variable | Description | Default |
| ---------------------- | ------------------------------------ | ------------------------------------------- |
| `VALIDATOR_SECRET_KEY` | BIP39 mnemonic or hex key | Required |
| `SUBTENSOR_ENDPOINT` | Bittensor RPC endpoint | `wss://entrypoint-finney.opentensor.ai:443` |
| `NETUID` | Subnet UID | `100` |
| `RUST_LOG` | Log level | `info` |
| `PLATFORM_SERVER_URL` | Platform server URL | `https://chain.platform.network` |
| `PLATFORM_PUBLIC_URL` | Public URL for challenge containers | Required |
| `DATABASE_URL` | PostgreSQL connection (server only) | Required for platform-server |
| `OWNER_HOTKEY` | Subnet owner hotkey | Required for platform-server |
| `BROKER_WS_PORT` | Container broker WebSocket port | `8090` |
| `BROKER_JWT_SECRET` | JWT secret for broker authentication | Required |
| Variable | Description | Default | Required |
| ---------------------- | ------------------------------------ | ------------------------------------------- | ------------ |
| `VALIDATOR_SECRET_KEY` | BIP39 mnemonic or hex key | - | Yes |
| `SUBTENSOR_ENDPOINT` | Bittensor RPC endpoint | `wss://entrypoint-finney.opentensor.ai:443` | No |
| `NETUID` | Subnet UID | `100` | No |
| `RUST_LOG` | Log level | `info` | No |
| `PLATFORM_SERVER_URL` | Platform server URL | `https://chain.platform.network` | No |
| `PLATFORM_PUBLIC_URL` | Public URL for challenge containers | - | Yes |
| `DATABASE_URL` | PostgreSQL connection (server only) | - | Yes (server) |
| `OWNER_HOTKEY` | Subnet owner hotkey | - | Yes (server) |
| `BROKER_WS_PORT` | Container broker WebSocket port | `8090` | No |
| `BROKER_JWT_SECRET` | JWT secret for broker authentication | - | Yes |

## Binary

Expand Down