Skip to content

Add the server to Komodo via the Core API / UI. #1060

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

Closed
sky150 wants to merge 1 commit into from
+21 −0
Closed

Add the server to Komodo via the Core API / UI. #1060

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
21 changes: 21 additions & 0 deletions docsite/docs/setup/connect-servers.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,3 +139,24 @@ wget -P komodo https://raw.githubusercontent.com/moghtech/komodo/main/config/per
language="toml"
/>
```

## Add Server to Komodo
After installing Periphery on your server, you need to add it to Komodo Core:

### Via UI
1. Navigate to the Servers page in Komodo
2. Click Create Server
3. Enter the server details:
- Name: A name for your server
- Address: The HTTPS/HTTP address of your Periphery agent (e.g., https://12.34.56.78:8120)

:::warning
After creating the server, it will be **disabled by default**
:::

4. Click on your newly created server and toggle "Enabled" to ON

### Via API
You can also add servers programmatically using the Komodo API. When creating via API, ensure you set `"enabled": true` in the server config to avoid the server being disabled by default.

See the [CreateServer documentation](https://docs.rs/komodo_client/latest/komodo_client/api/write/struct.CreateServer.html) for full details on the /write/CreateServer endpoint.