11-Admin - blame None – FilaMan Documentation

Blame

57076d	Manuel Weiser	2026-02-23 16:43:14
update

# 11. Admin Area

**URL:** `http(s)://url/admin`

![Admin Panel](../images/admin-panel.png)

> ⚠️ **Note:** The Admin area is only visible and accessible to users with the **Administrator role**.

The Admin Panel is the central hub for **system administration**. It provides access to the following sections:

| Card | Description |

|------|-------------|

| **Users** | User management |

| **Roles & Permissions** | Roles and permissions |

| **Devices** | Device token management |

| **System Extra Fields** | System-wide extra fields for spools and filaments |

| **System** | Plugins and system management |

21fdf2	Manuel Weiser	2026-03-13 11:14:56
docs: Update admin documentation to include database backup and restore features

| **Database Backup** | Export and restore database backups |

f48813	Manuel Weiser	2026-03-02 13:55:54
docs: Add SpoolmanDB Import and Spoolman API plugin documentation; update login and admin sections for SSO support

| **OIDC / SSO** | OpenID Connect Single Sign-On configuration |

57076d	Manuel Weiser	2026-02-23 16:43:14
update

---

## 11.1 User Management (Users)

**URL:** `http(s)://url/admin/users`

![User Management](../images/admin-users.png)

Administrators can manage all users in the system here. The table shows:

| Column | Description |

|--------|-------------|

| **EMAIL** | User's email address (used for login) |

| **DISPLAY NAME** | Display name within the application |

| **STATUS** | Active / Inactive |

| **ROLES** | Assigned roles (e.g. Superadmin, User) |

| **ACTIONS** | Edit / Reset PW |

Available actions:

- **Add User** (top right) – Create a new user with email, password, and role

- **Edit** – Change a user's email, name, or role

- **Reset PW** – Reset a user's password

---

## 11.2 Roles & Permissions

**URL:** `http(s)://url/admin/roles`

![Roles & Permissions](../images/admin-roles.png)

FilaMan ships with three **built-in system roles** that cannot be deleted:

| Role | Key | Description |

|------|-----|-------------|

| **Administrator** | `admin` | Full access to all features and the admin area |

| **User** | `user` | Standard user with read and write access |

| **Viewer** | `viewer` | Read-only access |

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.

Click on a role to view and edit its assigned permissions in the **Permissions** panel on the right.

---

## 11.3 Devices

**URL:** `http(s)://url/admin/devices`

![Device Management](../images/admin-devices.png)

ae873c	Manuel Weiser	2026-02-26 21:17:39
Add BambuLab plugin documentation and integration details - Updated contents in German and English to include a new section for the BambuLab plugin. - Modified printer management documentation to reflect BambuLab printer specifics. - Enhanced admin area with device actions and auto-assign configuration for BambuLab integration. - Added detailed configuration and parameter management for BambuLab printers. - Included migration notes for users updating from older versions of the BambuLab plugin.

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.

57076d	Manuel Weiser	2026-02-23 16:43:14
update

ae873c	Manuel Weiser	2026-02-26 21:17:39
Add BambuLab plugin documentation and integration details - Updated contents in German and English to include a new section for the BambuLab plugin. - Modified printer management documentation to reflect BambuLab printer specifics. - Enhanced admin area with device actions and auto-assign configuration for BambuLab integration. - Added detailed configuration and parameter management for BambuLab printers. - Included migration notes for users updating from older versions of the BambuLab plugin.

### Device Actions

- **Add device** – Create a new device with a name and optional device code

- **Create token** – Generate a new API token for a device

57076d	Manuel Weiser	2026-02-23 16:43:14
update

- **Revoke token** – Disable access for a device

ae873c	Manuel Weiser	2026-02-26 21:17:39
Add BambuLab plugin documentation and integration details - Updated contents in German and English to include a new section for the BambuLab plugin. - Modified printer management documentation to reflect BambuLab printer specifics. - Enhanced admin area with device actions and auto-assign configuration for BambuLab integration. - Added detailed configuration and parameter management for BambuLab printers. - Included migration notes for users updating from older versions of the BambuLab plugin.

- **Edit** – Change device name and settings

### Auto-Assign Configuration

For each device, the following settings for **automatic spool assignment** can be configured:

| Setting | Description |

|---------|-------------|

| **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. |

| **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. |

> **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.

fe70cf	Manuel Weiser	2026-03-09 08:10:11
Update documentation links to use consistent casing and absolute paths - Changed links in German documentation to use absolute paths with consistent casing. - Updated links in English documentation to follow the same format. - Ensured all navigation links point to the correct sections across all documents.

For more details on the workflow: → [Printers: Automatic Spool Assignment](/Docs/En/09-Printers#automatic-spool-assignment-auto-assignment)

57076d	Manuel Weiser	2026-02-23 16:43:14
update

---

## 11.4 Extra Fields

**URL:** `http(s)://url/admin/extra-fields`

100

![Extra Fields](../images/admin-extra-fields.png)

101

102

**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.

103

104

| Column | Description |

105

|--------|-------------|

106

| **TARGET TYPE** | Whether the field applies to filaments or spools |

107

| **KEY (JSON)** | Internal JSON key for the field |

108

| **DISPLAY LABEL** | Label shown in the user interface |

109

| **DEFAULT VALUE (OPTIONAL)** | Optional default value |

110

111

Click **"Add Field"** (top right) to create a new extra field.

112

113

Examples for extra fields:

114

- "Drying time" for spools

115

- "Print temperature" for filaments

116

- "Supplier" as an additional manufacturer field

117

118

Once extra fields are created, they appear as additional input fields in the corresponding forms (Add Spool, Add Filament).

119

120

---

121

ae873c	Manuel Weiser	2026-02-26 21:17:39
Add BambuLab plugin documentation and integration details - Updated contents in German and English to include a new section for the BambuLab plugin. - Modified printer management documentation to reflect BambuLab printer specifics. - Enhanced admin area with device actions and auto-assign configuration for BambuLab integration. - Added detailed configuration and parameter management for BambuLab printers. - Included migration notes for users updating from older versions of the BambuLab plugin.

122

## 11.5 System (Plugin Management)

57076d	Manuel Weiser	2026-02-23 16:43:14
update

123

124

**URL:** `http(s)://url/admin/system`

125

126

![System Settings](../images/admin-system.png)

127

ae873c	Manuel Weiser	2026-02-26 21:17:39
Add BambuLab plugin documentation and integration details - Updated contents in German and English to include a new section for the BambuLab plugin. - Modified printer management documentation to reflect BambuLab printer specifics. - Enhanced admin area with device actions and auto-assign configuration for BambuLab integration. - Added detailed configuration and parameter management for BambuLab printers. - Included migration notes for users updating from older versions of the BambuLab plugin.

128

The System section is the central place for **plugin management**. All installed plugins are displayed and managed here.

129

130

### Plugin Overview

131

132

The plugin table shows all installed plugins with the following columns:

133

134

| Column | Description |

135

|--------|-------------|

136

| **NAME** | Plugin name and short description |

137

| **VERSION** | Installed version (e.g. 2.1.10) |

138

| **TYPE** | Plugin type: **Driver** (printer driver), **Import** (data import), or **Integration** (third-party connection) |

139

| **AUTHOR** | Plugin author |

140

| **STATUS** | Enabled/Disabled — toggleable via switch |

66cf3f	Manuel Weiser	2026-02-27 13:14:37
docs: Update plugin management details and add new printer models for BambuLab integration

141

|| **ACTIONS** | Details / Update (if available) / Open / Uninstall |

ae873c	Manuel Weiser	2026-02-26 21:17:39
Add BambuLab plugin documentation and integration details - Updated contents in German and English to include a new section for the BambuLab plugin. - Modified printer management documentation to reflect BambuLab printer specifics. - Enhanced admin area with device actions and auto-assign configuration for BambuLab integration. - Added detailed configuration and parameter management for BambuLab printers. - Included migration notes for users updating from older versions of the BambuLab plugin.

142

143

### Installing a Plugin

144

145

Click **"Install Plugin"** in the top right. A dialog opens with two installation options:

146

147

#### Option 1: Install from Plugin Registry (recommended)

148

149

1. The **"Install from Registry"** dropdown shows all available plugins

150

2. The list is automatically loaded from the official plugin repository ([Fire-Devils/filaman-plugins](https://github.com/Fire-Devils/filaman-plugins)) on GitHub

151

3. Select the desired plugin from the dropdown — name, version, and description are displayed

152

4. Click **"Install Plugin"** to start the installation

153

5. FilaMan automatically downloads, validates, and installs the plugin

154

155

#### Option 2: Upload ZIP file manually

156

157

1. Below the registry dropdown, you'll find the **"Plugin ZIP File"** section

158

2. Drag and drop a `.zip` file into the marked area — or click to select a file

159

3. The file is automatically validated (structure, manifest, security)

160

4. On successful validation, a confirmation with plugin details appears

161

5. Click **"Install Plugin"** to complete the installation

162

163

> **Note:** Manual ZIP uploads are intended for developers or for plugins that are not yet available in the official registry.

164

165

### Checking for Updates

166

167

Click **"Check for Updates"** in the top right, next to the Install button.

168

169

- FilaMan compares installed plugin versions with the latest versions in the registry

170

- If updates are available, a notification shows the number of available updates

66cf3f	Manuel Weiser	2026-02-27 13:14:37
docs: Update plugin management details and add new printer models for BambuLab integration

171

- Each plugin with an available update gets an **"Update to v…"** button directly in the plugin table

172

- Click this button to update the respective plugin to the latest version — no need to go through "Install Plugin" anymore

ae873c	Manuel Weiser	2026-02-26 21:17:39
Add BambuLab plugin documentation and integration details - Updated contents in German and English to include a new section for the BambuLab plugin. - Modified printer management documentation to reflect BambuLab printer specifics. - Enhanced admin area with device actions and auto-assign configuration for BambuLab integration. - Added detailed configuration and parameter management for BambuLab printers. - Included migration notes for users updating from older versions of the BambuLab plugin.

173

174

### Enabling / Disabling a Plugin

175

176

Each plugin can be enabled or disabled via the **toggle switch** in the Status column:

177

178

- **Enabled** — The plugin is active and its features are available (e.g. printer drivers are loaded)

179

- **Disabled** — The plugin remains installed but is inactive. Already connected printers will be disconnected

180

181

### Uninstalling a Plugin

182

183

1. Click **"Uninstall"** in the Actions column of the plugin

184

2. Confirm the uninstallation in the confirmation dialog

185

3. An additional prompt asks whether to also delete the **plugin data** (e.g. extra fields, printer parameters):

186

   - **Yes** — Removes the plugin and all associated data (extra fields, saved parameters)

187

   - **No** — Removes only the plugin; data is preserved (useful when reinstalling)

188

189

### Plugin Details

190

191

Click **"Details"** to view detailed information about a plugin:

192

193

- Plugin name, version, and description

194

- Plugin type (Driver / Import / Integration)

195

- Author and homepage

196

- Supported capabilities (e.g. AMS support, RFID, Auto-Match)

197

- List of printer parameters created by the plugin

57076d	Manuel Weiser	2026-02-23 16:43:14
update

198

199

---

200

21fdf2	Manuel Weiser	2026-03-13 11:14:56
docs: Update admin documentation to include database backup and restore features

201

## 11.6 Database Backup & Restore

202

203

**URL:** `http(s)://url/admin/backup`

204

205

> ⚠️ **Note:** All backup and restore functions are only available to **superadmins**.

206

207

The Backup section provides comprehensive tools to back up and restore the FilaMan database. Two backup modes are available: **Full Backup** (all data) and **Inventory Backup** (inventory data only).

208

209

### Export Full Backup

210

211

Exports **all data** from the database as a JSON file, including:

212

- Users, passwords, API keys, and sessions

213

- Roles and permissions

214

- Devices and plugins

215

- All inventory data (manufacturers, filaments, spools, printers, colors, locations, etc.)

216

217

Click **"Export Backup"** to download the file. The filename automatically includes a timestamp (e.g. `filaman_backup_20260313_120000.json`).

218

219

> ⚠️ **Security warning:** The exported file contains **sensitive data** (password hashes, API keys). Store this file securely and do not share it with others!

220

221

### Import Full Backup

222

223

Restores a previously exported full backup.

224

225

1. Select a `.json` backup file using the file upload

226

2. Click **"Import Backup"**

227

3. Confirm the operation in the confirmation dialog

228

4. A progress bar shows the import status

229

5. After a successful import, the page reloads automatically

230

231

> 🚨 **Warning:** Importing will **DELETE ALL existing data** and replace it with the backup data! An automatic safety backup of the current data is created before the import.

232

233

### Export Inventory

234

235

Exports **only inventory data** as a JSON file:

236

- Manufacturers, colors, locations

237

- Filaments and spools

238

- Printers and printer slots

239

- Ratings, events, and extra fields

240

241

**Not included:** Users, passwords, API keys, sessions, roles, permissions, devices, plugins, and OIDC settings.

242

243

Click **"Export Inventory"** to download the file (e.g. `filaman_inventory_20260313_120000.json`).

244

245

> ✅ **Safe to share:** The inventory export contains no sensitive authentication data and can be safely exchanged between FilaMan instances.

246

247

### Import Inventory

248

249

Imports inventory data from another FilaMan instance. Users, roles, devices, and plugins remain **unchanged**.

250

251

1. Select a `.json` inventory file using the file upload

252

2. Click **"Import Inventory"**

253

3. Confirm the operation in the confirmation dialog

254

4. The import progress is shown with a progress bar

255

256

> ⚠️ **Warning:** Importing will **delete existing inventory data** and replace it with the imported data! Users and settings are preserved. An automatic safety backup is created before the import.

257

258

### SQLite Backups

259

260

> **Note:** This section is only visible when FilaMan is running with a **SQLite database**. For MySQL or PostgreSQL, backups must be managed externally by the administrator.

261

262

FilaMan automatically creates SQLite database backups (daily and before updates). These are stored in the backup directory (default: `/app/data/backups`).

263

264

The table shows all available backups with the following information:

265

266

| Column | Description |

267

|--------|-------------|

268

| **File** | Backup filename |

269

| **Date** | Creation date |

270

| **Size** | File size |

271

272

Two actions are available for each backup:

273

- **Restore** — Restores the database from this backup. An automatic backup of the current database is created before the restore. After restoring, the application must be reloaded.

274

- **Delete** — Permanently deletes the selected backup file.

275

276

---

277

278

## 11.7 OIDC / SSO

f48813	Manuel Weiser	2026-03-02 13:55:54
docs: Add SpoolmanDB Import and Spoolman API plugin documentation; update login and admin sections for SSO support

279

280

**URL:** `http(s)://url/admin/oidc`

281

282

> ⚠️ **Note:** The OIDC card on the Admin Panel is only clickable when accessing FilaMan via **HTTPS**. On HTTP connections, the card displays a notice that OIDC requires HTTPS and is not clickable.

283

284

This section allows administrators to configure **OpenID Connect (OIDC)** for Single Sign-On (SSO). Users can then log in using an external identity provider (e.g. Authentik, Keycloak, Azure AD).

285

286

### Configuration Fields

287

288

| Setting | Description |

289

|---------|-------------|

290

| **Enabled** | Toggle to enable or disable OIDC login |

291

| **Issuer URL** | The OIDC provider's issuer URL (must be `https://`) |

292

| **Client ID** | The client ID registered with your OIDC provider |

293

| **Client Secret** | The client secret (stored encrypted in the database) |

294

| **Scopes** | OIDC scopes to request (default: `openid email profile`) |

295

| **Button Text** | Custom label for the SSO button on the login page (e.g. "Login with Authentik") |

296

297

### Requirements

298

299

- **HTTPS required** — OIDC only works when FilaMan is accessed via HTTPS

300

- **`OIDC_ENC_KEY` environment variable** — Must be set for encrypting the client secret. Generate with:

301

```bash

302

  openssl rand -hex 32

303

```

304

- **Existing users only** — Only users who already exist in FilaMan can log in via OIDC. The provider's email address must match an existing user account. The email must be verified by the provider.

305

- **No auto-creation** — OIDC login does not create new user accounts

306

307

---

308

21fdf2	Manuel Weiser	2026-03-13 11:14:56
docs: Update admin documentation to include database backup and restore features

309

## 11.8 Danger Zone

57076d	Manuel Weiser	2026-02-23 16:43:14
update

310

311

At the bottom of the Admin Panel you will find the red-highlighted **Danger Zone** with one critical action:

312

313

> ⛔ **"Delete all data"**

314

> Permanently deletes **all** spools, filaments, manufacturers, colors, locations, and printers, including all logs and events.  

315

> **User accounts, roles, permissions, and devices are not affected.**

316

> This action **cannot be undone!**

317

318

---

319

fe70cf	Manuel Weiser	2026-03-09 08:10:11
Update documentation links to use consistent casing and absolute paths - Changed links in German documentation to use absolute paths with consistent casing. - Updated links in English documentation to follow the same format. - Ensured all navigation links point to the correct sections across all documents.

320

← [Back: Settings](/Docs/En/10-Settings) | [Next: Color Management →](/Docs/En/12-Colors)