Skip to content

feat(api): rename /config to /setup #70

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
ssilvius merged 2 commits into from
Jan 24, 2026
Merged

feat(api): rename /config to /setup #70

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
3f4cde7
feat(api): rename /config to /setup for config download
Jan 24, 2026
750b8ed
docs: add self-hosting setup documentation
Jan 24, 2026
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
42 changes: 41 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,47 @@ pnpm install
pnpm dev
```

See [API Documentation](https://ctd.ezmode.games/docs) for endpoints.
### API Endpoints

| Endpoint | Description |
|----------|-------------|
| `POST /crashes` | Submit a crash report |
| `GET /crashes/{id}` | Get crash report details |
| `POST /api-keys` | Create an API key |
| `GET /api-keys` | List your API keys |
| `GET /setup?key=<api_key>` | Download ctd.toml config |
| `GET /patterns` | List crash patterns |
| `GET /patterns/{id}` | Pattern details with mod correlations |
| `GET /calibration/metrics` | Prediction calibration metrics |
| `GET /docs` | Interactive API documentation |

### User Setup

Users need a `ctd.toml` config file with your server URL and their API key.

**Option 1: Download via API**
```bash
curl "https://your-server.com/setup?key=ctd_yourkey" -o ctd.toml
```

**Option 2: Manual creation**
```toml
# ctd.toml
[api]
url = "https://your-server.com"
api_key = "ctd_yourkey"
```

**Installation paths:**
| Game | Path |
|------|------|
| Skyrim SE | `Data/SKSE/Plugins/ctd.toml` |
| Fallout 4 | `Data/F4SE/Plugins/ctd.toml` |
| Fallout 3 | `Data/FOSE/Plugins/ctd.toml` |
| Fallout: New Vegas | `Data/NVSE/Plugins/ctd.toml` |
| Cyberpunk 2077 | `red4ext/plugins/ctd/ctd.toml` |

See [API Documentation](https://ctd.ezmode.games/docs) for full endpoint details.

## License

Expand Down
2 changes: 1 addition & 1 deletion api/src/app.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ app.get('/health', (c) => {
// Mount route apps
app.route('/api-keys', apiKeysApp);
app.route('/calibration', calibrationApp);
app.route('/config', configApp);
app.route('/setup', configApp);
Copy link

Copilot AI Jan 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are app-level Vitest smoke tests (e.g., /health, 404), but nothing asserting that the config download route is mounted at the new /setup path. Adding a simple test that /setup responds (e.g., 401 for missing/invalid key) would prevent regressions on future route refactors.

Copilot uses AI. Check for mistakes.
Copy link

Copilot AI Jan 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changing the mount from /config to /setup is a breaking API change: any existing clients calling /config will now get a 404. If backward compatibility is desired, consider temporarily mounting the same router on both paths (or adding a redirect/deprecation response on /config) and documenting a removal timeline.

Suggested change
app.route('/setup', configApp);
app.route('/setup', configApp);
app.route('/config', configApp);

Copilot uses AI. Check for mistakes.
app.route('/crashes', crashesApp);
app.route('/patterns', patternsApp);

Expand Down