11. Admin Area

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

⚠️ 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:

11.1 User Management (Users)

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

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

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

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

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

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.

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
• Revoke token – Disable access for a device
• Edit – Change device name and settings

Auto-Assign Configuration

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

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.

For more details on the workflow: → Printers: Automatic Spool Assignment

11.4 Extra Fields

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

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.

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

Examples for extra fields:

• "Drying time" for spools
• "Print temperature" for filaments
• "Supplier" as an additional manufacturer field

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

11.5 System (Plugin Management)

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

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

Plugin Overview

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

Installing a Plugin

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

Option 1: Install from Plugin Registry (recommended)

1. The "Install from Registry" dropdown shows all available plugins
2. The list is automatically loaded from the official plugin repository (Fire-Devils/filaman-plugins) on GitHub
3. Select the desired plugin from the dropdown — name, version, and description are displayed
4. Click "Install Plugin" to start the installation
5. FilaMan automatically downloads, validates, and installs the plugin

Option 2: Upload ZIP file manually

1. Below the registry dropdown, you'll find the "Plugin ZIP File" section
2. Drag and drop a .zip file into the marked area — or click to select a file
3. The file is automatically validated (structure, manifest, security)
4. On successful validation, a confirmation with plugin details appears
5. Click "Install Plugin" to complete the installation

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

Checking for Updates

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

• FilaMan compares installed plugin versions with the latest versions in the registry
• If updates are available, a notification shows the number of available updates
• Each plugin with an available update gets an "Update to v…" button directly in the plugin table
• Click this button to update the respective plugin to the latest version — no need to go through "Install Plugin" anymore

Enabling / Disabling a Plugin

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

• Enabled — The plugin is active and its features are available (e.g. printer drivers are loaded)
• Disabled — The plugin remains installed but is inactive. Already connected printers will be disconnected

Uninstalling a Plugin

1. Click "Uninstall" in the Actions column of the plugin
2. Confirm the uninstallation in the confirmation dialog
3. An additional prompt asks whether to also delete the plugin data (e.g. extra fields, printer parameters):
   • Yes — Removes the plugin and all associated data (extra fields, saved parameters)
   • No — Removes only the plugin; data is preserved (useful when reinstalling)

Plugin Details

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

• Plugin name, version, and description
• Plugin type (Driver / Import / Integration)
• Author and homepage
• Supported capabilities (e.g. AMS support, RFID, Auto-Match)
• List of printer parameters created by the plugin

11.6 Database Backup & Restore

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

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

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

Export Full Backup

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

• Users, passwords, API keys, and sessions
• Roles and permissions
• Devices and plugins
• All inventory data (manufacturers, filaments, spools, printers, colors, locations, etc.)

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

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

Import Full Backup

Restores a previously exported full backup.

1. Select a .json backup file using the file upload
2. Click "Import Backup"
3. Confirm the operation in the confirmation dialog
4. A progress bar shows the import status
5. After a successful import, the page reloads automatically

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

Export Inventory

Exports only inventory data as a JSON file:

• Manufacturers, colors, locations
• Filaments and spools
• Printers and printer slots
• Ratings, events, and extra fields

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

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

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

Import Inventory

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

1. Select a .json inventory file using the file upload
2. Click "Import Inventory"
3. Confirm the operation in the confirmation dialog
4. The import progress is shown with a progress bar

⚠️ 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.

SQLite Backups

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.

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

The table shows all available backups with the following information:

Two actions are available for each backup:

• 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.
• Delete — Permanently deletes the selected backup file.

11.7 OIDC / SSO

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

⚠️ 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.

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

Configuration Fields

Requirements

• HTTPS required — OIDC only works when FilaMan is accessed via HTTPS
• OIDC_ENC_KEY environment variable — Must be set for encrypting the client secret. Generate with:
  openssl rand -hex 32
  

• 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.
• No auto-creation — OIDC login does not create new user accounts

11.8 Danger Zone

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

⛔ "Delete all data"
Permanently deletes all spools, filaments, manufacturers, colors, locations, and printers, including all logs and events.
User accounts, roles, permissions, and devices are not affected.
This action cannot be undone!

← Back: Settings | Next: Color Management →