Blame
|
1 | # 11. Admin Area |
||||||
| 2 | ||||||||
| 3 | **URL:** `http(s)://url/admin` |
|||||||
| 4 | ||||||||
| 5 |  |
|||||||
| 6 | ||||||||
| 7 | > ⚠️ **Note:** The Admin area is only visible and accessible to users with the **Administrator role**. |
|||||||
| 8 | ||||||||
| 9 | The Admin Panel is the central hub for **system administration**. It provides access to the following sections: |
|||||||
| 10 | ||||||||
| 11 | | Card | Description | |
|||||||
| 12 | |------|-------------| |
|||||||
| 13 | | **Users** | User management | |
|||||||
| 14 | | **Roles & Permissions** | Roles and permissions | |
|||||||
| 15 | | **Devices** | Device token management | |
|||||||
| 16 | | **System Extra Fields** | System-wide extra fields for spools and filaments | |
|||||||
| 17 | | **System** | Plugins and system management | |
|||||||
| 18 | ||||||||
| 19 | --- |
|||||||
| 20 | ||||||||
| 21 | ## 11.1 User Management (Users) |
|||||||
| 22 | ||||||||
| 23 | **URL:** `http(s)://url/admin/users` |
|||||||
| 24 | ||||||||
| 25 |  |
|||||||
| 26 | ||||||||
| 27 | Administrators can manage all users in the system here. The table shows: |
|||||||
| 28 | ||||||||
| 29 | | Column | Description | |
|||||||
| 30 | |--------|-------------| |
|||||||
| 31 | | **EMAIL** | User's email address (used for login) | |
|||||||
| 32 | | **DISPLAY NAME** | Display name within the application | |
|||||||
| 33 | | **STATUS** | Active / Inactive | |
|||||||
| 34 | | **ROLES** | Assigned roles (e.g. Superadmin, User) | |
|||||||
| 35 | | **ACTIONS** | Edit / Reset PW | |
|||||||
| 36 | ||||||||
| 37 | Available actions: |
|||||||
| 38 | - **Add User** (top right) – Create a new user with email, password, and role |
|||||||
| 39 | - **Edit** – Change a user's email, name, or role |
|||||||
| 40 | - **Reset PW** – Reset a user's password |
|||||||
| 41 | ||||||||
| 42 | --- |
|||||||
| 43 | ||||||||
| 44 | ## 11.2 Roles & Permissions |
|||||||
| 45 | ||||||||
| 46 | **URL:** `http(s)://url/admin/roles` |
|||||||
| 47 | ||||||||
| 48 |  |
|||||||
| 49 | ||||||||
| 50 | FilaMan ships with three **built-in system roles** that cannot be deleted: |
|||||||
| 51 | ||||||||
| 52 | | Role | Key | Description | |
|||||||
| 53 | |------|-----|-------------| |
|||||||
| 54 | | **Administrator** | `admin` | Full access to all features and the admin area | |
|||||||
| 55 | | **User** | `user` | Standard user with read and write access | |
|||||||
| 56 | | **Viewer** | `viewer` | Read-only access | |
|||||||
| 57 | ||||||||
| 58 | Click **"Create Role"** (top right) to create custom roles with specific permissions. Use **"Edit Permissions"** to fine-tune what each role is allowed to do. |
|||||||
| 59 | ||||||||
| 60 | Click on a role to view and edit its assigned permissions in the **Permissions** panel on the right. |
|||||||
| 61 | ||||||||
| 62 | --- |
|||||||
| 63 | ||||||||
| 64 | ## 11.3 Devices |
|||||||
| 65 | ||||||||
| 66 | **URL:** `http(s)://url/admin/devices` |
|||||||
| 67 | ||||||||
| 68 |  |
|||||||
| 69 | ||||||||
|
70 | This section manages **external devices** that communicate with the FilaMan API (e.g. ESP32 scales with RFID scanners). Each device receives its own API token for authentication. |
||||||
|
71 | |||||||
|
72 | ### Device Actions |
||||||
| 73 | ||||||||
| 74 | - **Add device** – Create a new device with a name and optional device code |
|||||||
| 75 | - **Create token** – Generate a new API token for a device |
|||||||
|
76 | - **Revoke token** – Disable access for a device |
||||||
|
77 | - **Edit** – Change device name and settings |
||||||
| 78 | ||||||||
| 79 | ### Auto-Assign Configuration |
|||||||
| 80 | ||||||||
| 81 | For each device, the following settings for **automatic spool assignment** can be configured: |
|||||||
| 82 | ||||||||
| 83 | | Setting | Description | |
|||||||
| 84 | |---------|-------------| |
|||||||
| 85 | | **Auto-Assign enabled** | When enabled, weighing a spool on this device will automatically send a pending assignment to all connected printers. As soon as the spool is inserted into an AMS slot, the filament settings are automatically transmitted. | |
|||||||
| 86 | | **Auto-Assign Timeout** | Time in seconds after which a pending assignment is automatically discarded (default: 60 seconds). If no spool is inserted within this time, the assignment expires. | |
|||||||
| 87 | ||||||||
| 88 | > **Note:** Auto-Assign is configured per device, not per printer. When Auto-Assign is enabled for a device, ALL connected printers are notified. The assignment then happens automatically on whichever printer the spool is actually inserted into. |
|||||||
| 89 | ||||||||
| 90 | For more details on the workflow: → [Printers: Automatic Spool Assignment](09-printers.md#automatic-spool-assignment-auto-assignment) |
|||||||
|
91 | |||||||
| 92 | --- |
|||||||
| 93 | ||||||||
| 94 | ## 11.4 Extra Fields |
|||||||
| 95 | ||||||||
| 96 | **URL:** `http(s)://url/admin/extra-fields` |
|||||||
| 97 | ||||||||
| 98 |  |
|||||||
| 99 | ||||||||
| 100 | **System Extra Fields** allow administrators to define additional data fields for spools and filaments beyond the standard fields. These fields are automatically added to all filaments or spools. |
|||||||
| 101 | ||||||||
| 102 | | Column | Description | |
|||||||
| 103 | |--------|-------------| |
|||||||
| 104 | | **TARGET TYPE** | Whether the field applies to filaments or spools | |
|||||||
| 105 | | **KEY (JSON)** | Internal JSON key for the field | |
|||||||
| 106 | | **DISPLAY LABEL** | Label shown in the user interface | |
|||||||
| 107 | | **DEFAULT VALUE (OPTIONAL)** | Optional default value | |
|||||||
| 108 | ||||||||
| 109 | Click **"Add Field"** (top right) to create a new extra field. |
|||||||
| 110 | ||||||||
| 111 | Examples for extra fields: |
|||||||
| 112 | - "Drying time" for spools |
|||||||
| 113 | - "Print temperature" for filaments |
|||||||
| 114 | - "Supplier" as an additional manufacturer field |
|||||||
| 115 | ||||||||
| 116 | Once extra fields are created, they appear as additional input fields in the corresponding forms (Add Spool, Add Filament). |
|||||||
| 117 | ||||||||
| 118 | --- |
|||||||
| 119 | ||||||||
|
120 | ## 11.5 System (Plugin Management) |
||||||
|
121 | |||||||
| 122 | **URL:** `http(s)://url/admin/system` |
|||||||
| 123 | ||||||||
| 124 |  |
|||||||
| 125 | ||||||||
|
126 | The System section is the central place for **plugin management**. All installed plugins are displayed and managed here. |
||||||
| 127 | ||||||||
| 128 | ### Plugin Overview |
|||||||
| 129 | ||||||||
| 130 | The plugin table shows all installed plugins with the following columns: |
|||||||
| 131 | ||||||||
| 132 | | Column | Description | |
|||||||
| 133 | |--------|-------------| |
|||||||
| 134 | | **NAME** | Plugin name and short description | |
|||||||
| 135 | | **VERSION** | Installed version (e.g. 2.1.10) | |
|||||||
| 136 | | **TYPE** | Plugin type: **Driver** (printer driver), **Import** (data import), or **Integration** (third-party connection) | |
|||||||
| 137 | | **AUTHOR** | Plugin author | |
|||||||
| 138 | | **STATUS** | Enabled/Disabled — toggleable via switch | |
|||||||
|
139 | || **ACTIONS** | Details / Update (if available) / Open / Uninstall | |
||||||
|
140 | |||||||
| 141 | ### Installing a Plugin |
|||||||
| 142 | ||||||||
| 143 | Click **"Install Plugin"** in the top right. A dialog opens with two installation options: |
|||||||
| 144 | ||||||||
| 145 | #### Option 1: Install from Plugin Registry (recommended) |
|||||||
| 146 | ||||||||
| 147 | 1. The **"Install from Registry"** dropdown shows all available plugins |
|||||||
| 148 | 2. The list is automatically loaded from the official plugin repository ([Fire-Devils/filaman-plugins](https://github.com/Fire-Devils/filaman-plugins)) on GitHub |
|||||||
| 149 | 3. Select the desired plugin from the dropdown — name, version, and description are displayed |
|||||||
| 150 | 4. Click **"Install Plugin"** to start the installation |
|||||||
| 151 | 5. FilaMan automatically downloads, validates, and installs the plugin |
|||||||
| 152 | ||||||||
| 153 | #### Option 2: Upload ZIP file manually |
|||||||
| 154 | ||||||||
| 155 | 1. Below the registry dropdown, you'll find the **"Plugin ZIP File"** section |
|||||||
| 156 | 2. Drag and drop a `.zip` file into the marked area — or click to select a file |
|||||||
| 157 | 3. The file is automatically validated (structure, manifest, security) |
|||||||
| 158 | 4. On successful validation, a confirmation with plugin details appears |
|||||||
| 159 | 5. Click **"Install Plugin"** to complete the installation |
|||||||
| 160 | ||||||||
| 161 | > **Note:** Manual ZIP uploads are intended for developers or for plugins that are not yet available in the official registry. |
|||||||
| 162 | ||||||||
| 163 | ### Checking for Updates |
|||||||
| 164 | ||||||||
| 165 | Click **"Check for Updates"** in the top right, next to the Install button. |
|||||||
| 166 | ||||||||
| 167 | - FilaMan compares installed plugin versions with the latest versions in the registry |
|||||||
| 168 | - If updates are available, a notification shows the number of available updates |
|||||||
|
169 | - Each plugin with an available update gets an **"Update to v…"** button directly in the plugin table |
||||||
| 170 | - Click this button to update the respective plugin to the latest version — no need to go through "Install Plugin" anymore |
|||||||
|
171 | |||||||
| 172 | ### Enabling / Disabling a Plugin |
|||||||
| 173 | ||||||||
| 174 | Each plugin can be enabled or disabled via the **toggle switch** in the Status column: |
|||||||
| 175 | ||||||||
| 176 | - **Enabled** — The plugin is active and its features are available (e.g. printer drivers are loaded) |
|||||||
| 177 | - **Disabled** — The plugin remains installed but is inactive. Already connected printers will be disconnected |
|||||||
| 178 | ||||||||
| 179 | ### Uninstalling a Plugin |
|||||||
| 180 | ||||||||
| 181 | 1. Click **"Uninstall"** in the Actions column of the plugin |
|||||||
| 182 | 2. Confirm the uninstallation in the confirmation dialog |
|||||||
| 183 | 3. An additional prompt asks whether to also delete the **plugin data** (e.g. extra fields, printer parameters): |
|||||||
| 184 | - **Yes** — Removes the plugin and all associated data (extra fields, saved parameters) |
|||||||
| 185 | - **No** — Removes only the plugin; data is preserved (useful when reinstalling) |
|||||||
| 186 | ||||||||
| 187 | ### Plugin Details |
|||||||
| 188 | ||||||||
| 189 | Click **"Details"** to view detailed information about a plugin: |
|||||||
| 190 | ||||||||
| 191 | - Plugin name, version, and description |
|||||||
| 192 | - Plugin type (Driver / Import / Integration) |
|||||||
| 193 | - Author and homepage |
|||||||
| 194 | - Supported capabilities (e.g. AMS support, RFID, Auto-Match) |
|||||||
| 195 | - List of printer parameters created by the plugin |
|||||||
|
196 | |||||||
| 197 | --- |
|||||||
| 198 | ||||||||
| 199 | ## 11.6 Danger Zone |
|||||||
| 200 | ||||||||
| 201 | At the bottom of the Admin Panel you will find the red-highlighted **Danger Zone** with one critical action: |
|||||||
| 202 | ||||||||
| 203 | > ⛔ **"Delete all data"** |
|||||||
| 204 | > Permanently deletes **all** spools, filaments, manufacturers, colors, locations, and printers, including all logs and events. |
|||||||
| 205 | > **User accounts, roles, permissions, and devices are not affected.** |
|||||||
| 206 | > This action **cannot be undone!** |
|||||||
| 207 | ||||||||
| 208 | --- |
|||||||
| 209 | ||||||||
| 210 | ← [Back: Settings](10-settings.md) | [Next: Color Management →](12-colors.md) |
|||||||