Adding a Worker
Prerequisites
- An app.orter.dev account. If you do not have one, follow the Getting Started Guide.
- Access to a machine with a container runtime installed, such as Docker .
- (Optional, recommended) An existing collection to use with the worker.
Adding a Worker
Select a Collection
Navigate to the Collection you want to register with the new worker.
Open the Access Menu
In the vertical sidebar, select Access (hotkey a), then choose the Worker API Key submenu.
Generate a Worker API Key
Click Generate a new API Key. A window will display your API key. Copy and securely store the generated API key. Close the popup window.
Start Orter Worker Agent
export API_KEY=<your api key>
docker run -e API_KEY=$API_KEY ghcr.io/orter-rs/worker:latestYou can assign a unique identifier to your worker by setting the WORKER_ID environment variable. By default, the agent auto-generates an ID based on your host system.
Manage the Worker
The worker registers automatically with app.orter.dev and can be managed via the web interface.
Navigate to the Workers page (hotkey w). You should see the newly added worker and its status.
Use the + icon to assign additional collections to your Orter Worker Agent instance.
API Keys can be reused multiple times. This is useful for adding several worker instances concurrently.