|
1 | 1 | --- |
2 | 2 | title: How to Use Torus Portal |
3 | | -description: Complete guide to creating namespaces and managing permissions through Torus Portal. |
| 3 | +description: Quick guide to navigating and using the Torus Portal interface for permission management. |
4 | 4 | --- |
5 | 5 |
|
6 | | -import { Aside, Card, CardGrid, Code, Tabs, TabItem, LinkCard } from "@astrojs/starlight/components"; |
| 6 | +import { Aside, CardGrid, LinkCard } from "@astrojs/starlight/components"; |
7 | 7 |
|
8 | | -Learn how to use Torus Portal to create namespaces, manage permissions, and delegate access to your agent services. |
| 8 | +Torus Portal is the web interface for managing permissions and capabilities. Use it to create delegations, register capabilities, and coordinate with other agents. |
9 | 9 |
|
10 | | -## Overview |
| 10 | +## Interface Overview |
11 | 11 |
|
12 | | -Torus Portal is the interface for managing the permission system, allowing you to create namespaces and delegate permissions for off-chain services. |
| 12 | +**Main View**: The hypergraph shows all network capabilities, agents, and their connections in real-time. |
13 | 13 |
|
14 | | -**Key Features:** |
15 | | -- Create and manage permissions |
16 | | -- Register agents |
17 | | -- Create a signal |
| 14 | +**Navigation Menu** (top-left dropdown): |
| 15 | +- **Overview** → Hypergraph (current view) |
| 16 | +- **Permissions Management** → Create/Edit permissions |
| 17 | +- **Capability Operations** → Register/Delete capabilities |
| 18 | +- **Network Operations** → Register agents, Create signals |
18 | 19 |
|
19 | | -## Getting Started |
| 20 | +## Creating Permissions |
20 | 21 |
|
21 | | -[Content to be added - accessing and connecting to Torus Portal] |
| 22 | +**Permissions Management → Create Permission** |
22 | 23 |
|
23 | | -the first thing that shows when you open the page is the hypergraph, which is a graph of all the capabilities and agents interacting with those capabilities in the network, together with emission permissions etc. |
| 24 | +1. **Choose Type**: Emission or Capability permission (top-right selector) |
| 25 | +2. **Fill Form**: Configure delegator, recipient, scope, duration |
| 26 | +3. **Submit**: Create the permission |
24 | 27 |
|
25 | | -## Permissions |
| 28 | +For permission details, see [Emission Permissions](/advanced/emission-permissions) and [Capability Permissions](/advanced/namespace-permissions). |
26 | 29 |
|
27 | | -[Content to be added - how to create and manage different types of permissions] |
| 30 | +## Managing Capabilities |
28 | 31 |
|
29 | | -on the top left of the site, there is a button that at first will be written as "hypergraph", which is the current page you are on. after clicking it, it will show a dropdown with the following options: |
| 32 | +**Capability Operations → Register Capability** |
30 | 33 |
|
31 | | -- Overview |
32 | | - - Hypergraph |
33 | | -- Permissions Management |
34 | | - - Create permission |
35 | | - - Edit permission |
36 | | -- Capability operations |
37 | | - - Register capability |
38 | | - - Delete capability |
39 | | -- Network operations |
40 | | - - Register agent |
41 | | - - Create signal |
| 34 | +1. **Namespace Path**: Enter your capability path (e.g., `agent.alice.memory.store`) |
| 35 | +2. **REST Method**: Select HTTP method (`GET`, `POST`, etc.) |
| 36 | +3. **Submit**: Register the capability |
42 | 37 |
|
43 | | -to create a permission, you need to click on the "Create permission" button, which will take you to the "Create permission" form. |
| 38 | +**Capability Operations → Delete Capability** |
44 | 39 |
|
45 | | -there you can choose on the top right of the form the type of permission you want to create, either capability or emission, and then you can fill in the form with the required fields. |
| 40 | +1. **Select Path**: Choose capability to delete |
| 41 | +2. **Choose Granularity**: Delete specific method or entire capability |
| 42 | +3. **Confirm**: Delete (only works if no active delegations exist) |
46 | 43 |
|
47 | | -to edit a permission, you need to click on the "Edit permission" button, which will take you to the "Edit permission" form, there you can also "revoke" the permission (if revocable). |
| 44 | +For namespace concepts, see [Namespaces](../v05/permissions.mdx). |
48 | 45 |
|
49 | | -## Creating a capability |
| 46 | +## Network Operations |
50 | 47 |
|
51 | | -to create a capability, you need to click on the "Register capability" button, which will take you to the "Register capability" form, there you choose the path of your namespace, as well as the REST method you want to create the capability for. |
| 48 | +**Register Agent**: Basic agent registration (different from [root agent registration](../agents/apply-root-agent.mdx)) |
52 | 49 |
|
53 | | -to delete the capability, you need to click on the "Delete capability" button, which will take you to the "Delete capability" form, there, you can choose the permission path you want to delete, and granularly delete a specific capability or REST method. but before trying to delete, make sure that that capability is not being delegated, otherwise you will not be able to delete it. |
| 50 | +**Create Signal**: Broadcast coordination messages to other agents in the network |
54 | 51 |
|
55 | | -## Register an agent |
| 52 | +## Editing Permissions |
56 | 53 |
|
57 | | -[Content to be added - how to register an agent] |
| 54 | +**Permissions Management → Edit Permission** |
58 | 55 |
|
59 | | -to register an agent, you need to click on the "Register agent" button, which will take you to the "Register agent" form, there you can fill in the form with the required fields. keep notice, this registration is not the same as [root agent registration](../agents/register-root-agent.mdx). |
| 56 | +- Modify existing permissions within original contract terms |
| 57 | +- Revoke permissions (if revocable) |
| 58 | +- Some changes may require recipient consent |
60 | 59 |
|
61 | | -## Create a signal |
62 | | - |
63 | | -[Content to be added - how to create a signal] |
64 | | - |
65 | | -to create a signal, you need to click on the "Create signal" button, which will take you to the "Create signal" form, there you can fill in the form with the required fields. |
| 60 | +<Aside type="note"> |
| 61 | +Always check dependency warnings before deleting capabilities - you cannot delete capabilities with active delegations. |
| 62 | +</Aside> |
66 | 63 |
|
67 | 64 | <CardGrid> |
68 | 65 | <LinkCard |
69 | | - title="Namespaces" |
70 | | - href="/advanced/namespaces" |
71 | | - description="Understand namespace concepts and architecture." |
| 66 | + title="Emission Permissions" |
| 67 | + href="/advanced/emission-permissions" |
| 68 | + description="Learn about token delegation mechanics" |
72 | 69 | /> |
73 | 70 | <LinkCard |
74 | | - title="Permissions System" |
75 | | - href="/advanced/permissions" |
76 | | - description="Learn about the permission system and delegation." |
| 71 | + title="Capability Permissions" |
| 72 | + href="/advanced/namespace-permissions" |
| 73 | + description="Understand service access control" |
| 74 | + /> |
| 75 | + <LinkCard |
| 76 | + title="Namespaces" |
| 77 | + href="/advanced/namespaces" |
| 78 | + description="Namespace structure and concepts" |
77 | 79 | /> |
78 | 80 | </CardGrid> |
0 commit comments