@@ -209,7 +209,7 @@ The application includes a comprehensive REST API for programmatic access:
4.**API Keys**: Each user has a unique API key that can be viewed and regenerated from the Users page. API keys respect the same role-based permissions as the web interface.
5.**Documentation**: Full API documentation is available in the Help page of the web interface.
5.**Documentation**: See [API.md](API.md) for the full REST API reference.
<p>To add or edit subnets, go to the <ahref="/admin"class="text-blue-600 dark:text-blue-400 hover:underline">Admin</a> page. Click <spanclass="bg-gray-300 dark:bg-zinc-700 px-2 py-1 rounded">Add Subnet</span> to create a new subnet, or use the edit button to modify existing subnets. Subnets are associated with sites and can be organised by location.</p>
</div>
<div>
<h3class="text-xl font-semibold mb-1">Adding a Device</h3>
<p>To add a device, visit the <ahref="/devices"class="text-blue-600 dark:text-blue-400 hover:underline">Devices</a> page and click <spanclass="bg-gray-300 dark:bg-zinc-700 px-2 py-1 rounded">Add Device</span>.</p>
</div>
<div>
<h3class="text-xl font-semibold mb-1">Assigning IP Addresses</h3>
<p>To assign an IP address, you must first add a device. Then, from the <ahref="/devices"class="text-blue-600 dark:text-blue-400 hover:underline">Devices</a> page, click on a device to view its details and use the <spanclass="bg-gray-300 dark:bg-zinc-700 px-2 py-1 rounded">Add IP</span> option to assign an IP address from a subnet.</p>
</div>
<div>
<h3class="text-xl font-semibold mb-1">Viewing and Editing Devices</h3>
<p>Click on any device in the <ahref="/devices"class="text-blue-600 dark:text-blue-400 hover:underline">Devices</a> list to view or edit its details, including assigned IPs, device types and a description where necessary.</p>
<h3class="text-xl font-semibold mb-1">Adding a Rack</h3>
<p>To add a new rack, go to the <ahref="/racks"class="text-blue-600 dark:text-blue-400 hover:underline">Racks</a> page and click the <spanclass="bg-gray-300 dark:bg-zinc-700 px-2 py-1 rounded">Add Rack</span> button. Fill in the details and submit the form.</p>
</div>
<div>
<h3class="text-xl font-semibold mb-1">Assigning Devices to Racks</h3>
<p>After adding a device, you can assign it to a rack from the <ahref="/racks"class="text-blue-600 dark:text-blue-400 hover:underline">Rack</a> details page. Click on a rack from the <ahref="/racks"class="text-blue-600 dark:text-blue-400 hover:underline">Racks</a> page, then use the options to add or remove devices within the rack.</p>
<p>Racks can also contain non-networked devices (such as shelves, patch panels, or other equipment that does not require an IP address). To add a non-networked device, go to a rack details page and use the option to add a device by name without assigning an IP address. These devices will appear in the rack layout but will not be listed on the Devices page.</p>
<p>Tags help you organize and categorize your devices. Administrators can manage tags from the <ahref="/tags"class="text-blue-600 dark:text-blue-400 hover:underline">Tag Management</a> page accessible from the Admin panel. Each tag has a name, customizable colour, and optional description.</p>
<p>Click <spanclass="bg-gray-300 dark:bg-zinc-700 px-2 py-1 rounded">Add Tag</span> to create a new tag. Choose a descriptive name (e.g., "Production", "Development", "Critical") and select a colour to visually distinguish the tag. Tags can be used to group devices by environment, importance, location, or any other criteria.</p>
</div>
<div>
<h3class="text-xl font-semibold mb-1">Assigning Tags to Devices</h3>
<p>From any device's detail page, you can assign multiple tags using the tag assignment dropdown. Each device can have unlimited tags, and removing a tag is as simple as clicking the × button next to the tag name.</p>
</div>
<div>
<h3class="text-xl font-semibold mb-1">Filtering Devices by Tags</h3>
<p>On the <ahref="/devices"class="text-blue-600 dark:text-blue-400 hover:underline">Devices</a> page, use the tag filter dropdown to view only devices with a specific tag. This makes it easy to focus on devices in a particular environment or category.</p>
</div>
<div>
<h3class="text-xl font-semibold mb-1">Tag Colours and Visual Organisation</h3>
<p>Tags appear as coloured badges throughout the interface. Use consistent colour schemes (e.g., red for production, blue for development) to create visual patterns that help users quickly identify device categories.</p>
<p>Tag management respects role-based permissions. Users need appropriate permissions to view, create, edit, delete tags, or assign/remove tags from devices. View-only users can see tags but cannot modify them.</p>
<h3class="text-xl font-semibold mb-1">User & Role Management</h3>
<p>Administrators can manage users and roles from the <ahref="/users"class="text-blue-600 dark:text-blue-400 hover:underline">Users</a> page. This includes creating users, assigning roles, and managing custom roles with specific permission sets. Only users with the appropriate permissions can access this page.</p>
<p>Administrators can create custom roles with specific permission sets. Go to the <ahref="/users"class="text-blue-600 dark:text-blue-400 hover:underline">Users</a> page and click the "Roles & Permissions" tab to create and manage roles.</p>
<p>Permissions are very granular, allowing fine-grained control over what each role can do. Permissions are organised into categories like View, Device Management, Network Management, Rack Management, and Administration.</p>
<p>All changes are logged and can be reviewed on the <ahref="/audit"class="text-blue-600 dark:text-blue-400 hover:underline">Audit</a> page for accountability and troubleshooting. The audit log shows who made changes, what was changed, and when.</p>
<p>Each user has a unique API key that can be used to authenticate API requests. API keys can be viewed and regenerated from the <ahref="/users"class="text-blue-600 dark:text-blue-400 hover:underline">Users</a> page. Keep your API key secure and never share it publicly.</p>
</div>
</div>
</div>
</div>
</div>
</div>
</body>
</html>
Reference in New Issue
Block a user
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.