Commit 57076d
2026-02-23 16:43:14 Manuel Weiser: update| /dev/null .. .gitignore | |
| @@ 0,0 1,68 @@ | |
| + | # macOS |
| + | .DS_Store |
| + | .AppleDouble |
| + | .LSOverride |
| + | ._* |
| + | .Spotlight-V100 |
| + | .Trashes |
| + | |
| + | # Logs |
| + | logs |
| + | *.log |
| + | npm-debug.log* |
| + | yarn-debug.log* |
| + | yarn-error.log* |
| + | pnpm-debug.log* |
| + | |
| + | # Node / Astro / Tailwind |
| + | node_modules/ |
| + | dist/ |
| + | .astro/ |
| + | .vercel/ |
| + | .netlify/ |
| + | .vscode/ |
| + | |
| + | # Environment files |
| + | .env |
| + | .env.* |
| + | !.env.example |
| + | |
| + | # Python |
| + | __pycache__/ |
| + | *.py[cod] |
| + | *.pyd |
| + | *.egg-info/ |
| + | *.egg |
| + | .eggs/ |
| + | .venv/ |
| + | venv/ |
| + | ENV/ |
| + | .envrc |
| + | .pytest_cache/ |
| + | .mypy_cache/ |
| + | .ruff_cache/ |
| + | .coverage |
| + | htmlcov/ |
| + | |
| + | # Build artifacts |
| + | *.tsbuildinfo |
| + | *.map |
| + | *.swp |
| + | *.swo |
| + | |
| + | # OS / Editor |
| + | .idea/ |
| + | *.iml |
| + | |
| + | # Tailwind output |
| + | *.css.map |
| + | |
| + | # Misc |
| + | coverage/ |
| + | *.bak |
| + | *.tmp |
| + | *.db |
| + | spec |
| + | bump-version.sh |
| + | _* |
| + | local_cache |
| \ | No newline at end of file |
| docs/de/04-dashboard.md .. | |
| @@ 1,6 1,6 @@ | |
| # 4. Dashboard | |
| - | **URL:** `http://localhost:4321/` |
| + | **URL:** `http(s)://url/` |
|  | |
| docs/de/05-hersteller.md .. | |
| @@ 1,6 1,6 @@ | |
| # 5. Hersteller (Manufacturers) | |
| - | **URL:** `http://localhost:4321/manufacturers` |
| + | **URL:** `http(s)://url/manufacturers` |
|  | |
| docs/de/06-filamente.md .. | |
| @@ 1,6 1,6 @@ | |
| # 6. Filamente (Filaments) | |
| - | **URL:** `http://localhost:4321/filaments` |
| + | **URL:** `http(s)://url/filaments` |
|  | |
| docs/de/07-spulen.md .. | |
| @@ 1,6 1,6 @@ | |
| # 7. Spulen (Spools) | |
| - | **URL:** `http://localhost:4321/spools` |
| + | **URL:** `http(s)://url/spools` |
|  | |
| docs/de/08-lagerorte.md .. | |
| @@ 1,6 1,6 @@ | |
| # 8. Lagerorte (Locations) | |
| - | **URL:** `http://localhost:4321/locations` |
| + | **URL:** `http(s)://url/locations` |
|  | |
| docs/de/09-drucker.md .. | |
| @@ 1,6 1,6 @@ | |
| # 9. Drucker (Printers) | |
| - | **URL:** `http://localhost:4321/printers` |
| + | **URL:** `http(s)://url/printers` |
|  | |
| docs/de/10-einstellungen.md .. | |
| @@ 1,6 1,6 @@ | |
| # 10. Einstellungen (Settings) | |
| - | **URL:** `http://localhost:4321/settings` |
| + | **URL:** `http(s)://url/settings` |
|  | |
| docs/de/11-admin.md .. | |
| @@ 1,6 1,6 @@ | |
| # 11. Admin-Bereich | |
| - | **URL:** `http://localhost:4321/admin` |
| + | **URL:** `http(s)://url/admin` |
|  | |
| @@ 20,7 20,7 @@ | |
| ## 11.1 Benutzerverwaltung (Users) | |
| - | **URL:** `http://localhost:4321/admin/users` |
| + | **URL:** `http(s)://url/admin/users` |
|  | |
| @@ 43,7 43,7 @@ | |
| ## 11.2 Rollen & Berechtigungen (Roles & Permissions) | |
| - | **URL:** `http://localhost:4321/admin/roles` |
| + | **URL:** `http(s)://url/admin/roles` |
|  | |
| @@ 63,7 63,7 @@ | |
| ## 11.3 Geräte (Devices) | |
| - | **URL:** `http://localhost:4321/admin/devices` |
| + | **URL:** `http(s)://url/admin/devices` |
|  | |
| @@ 76,7 76,7 @@ | |
| ## 11.4 Zusatzfelder (Extra Fields) | |
| - | **URL:** `http://localhost:4321/admin/extra-fields` |
| + | **URL:** `http(s)://url/admin/extra-fields` |
|  | |
| @@ 102,7 102,7 @@ | |
| ## 11.5 System | |
| - | **URL:** `http://localhost:4321/admin/system` |
| + | **URL:** `http(s)://url/admin/system` |
|  | |
| /dev/null .. docs/en/00-contents.md | |
| @@ 0,0 1,31 @@ | |
| + | # FilaMan – User Manual |
| + | |
| + | **Version:** 1.0 |
| + | **Date:** February 2026 |
| + | **Language:** English |
| + | |
| + | --- |
| + | |
| + | FilaMan is a web-based management system for 3D printer filaments. This manual describes all features and pages of the application. |
| + | |
| + | ## Table of Contents |
| + | |
| + | | # | Chapter | Description | |
| + | |---|---------|-------------| |
| + | | 1 | [Introduction](01-introduction.md) | What is FilaMan? | |
| + | | 2 | [Login](02-login.md) | Signing in and out | |
| + | | 3 | [Navigation & UI](03-navigation.md) | Sidebar, menu, color themes | |
| + | | 4 | [Dashboard](04-dashboard.md) | Overview with statistics and alerts | |
| + | | 5 | [Manufacturers](05-manufacturers.md) | Managing filament manufacturers | |
| + | | 6 | [Filaments](06-filaments.md) | Creating and managing filament products | |
| + | | 7 | [Spools](07-spools.md) | Managing your physical stock | |
| + | | 8 | [Locations](08-locations.md) | Storage locations and RFID integration | |
| + | | 9 | [Printers](09-printers.md) | Managing and integrating 3D printers | |
| + | | 10 | [Settings](10-settings.md) | Updating profile and password | |
| + | | 11 | [Admin Area](11-admin.md) | Users, roles, devices, extra fields, system | |
| + | | 12 | [Color Management](12-colors.md) | Defining colors for filaments | |
| + | | 13 | [Tips & FAQ](13-faq.md) | Frequently asked questions | |
| + | |
| + | --- |
| + | |
| + | *For technical questions or issues, please contact your system administrator.* |
| /dev/null .. docs/en/01-introduction.md | |
| @@ 0,0 1,14 @@ | |
| + | # 1. Introduction |
| + | |
| + | **FilaMan** is a web-based management system for **3D printer filaments**. It helps you keep a complete overview of your entire filament inventory: |
| + | |
| + | - Which filaments and spools (rolls) you own |
| + | - How much filament remains on each spool |
| + | - Where your spools are stored |
| + | - Which printers use which filament |
| + | |
| + | FilaMan supports multiple users and role-based access control, ensuring each user only sees and interacts with the areas relevant to them. |
| + | |
| + | --- |
| + | |
| + | ← [Back to Table of Contents](00-contents.md) | [Next: Login →](02-login.md) |
| /dev/null .. docs/en/02-login.md | |
| @@ 0,0 1,19 @@ | |
| + | # 2. Login |
| + | |
| + | Open the FilaMan application in your browser. If you are not yet signed in, you will be automatically redirected to the login page. |
| + | |
| + |  |
| + | |
| + | **Login fields:** |
| + | - **Email** – Your registered email address |
| + | - **Password** – Your personal password |
| + | |
| + | Click **"Sign in"** to log in. |
| + | |
| + | > 💡 **Note:** If you have forgotten your password, please contact your system administrator. Password resets can be performed via the Admin area. |
| + | |
| + | After a successful login you will be taken directly to the **Dashboard**. |
| + | |
| + | --- |
| + | |
| + | ← [Back: Introduction](01-introduction.md) | [Next: Navigation & UI →](03-navigation.md) |
| /dev/null .. docs/en/03-navigation.md | |
| @@ 0,0 1,44 @@ | |
| + | # 3. Navigation & User Interface |
| + | |
| + |  |
| + | |
| + | The FilaMan user interface is divided into two main areas: |
| + | |
| + | ## Sidebar (Left Navigation) |
| + | |
| + | The sidebar contains all main menu items: |
| + | |
| + | | Icon | Menu Item | Description | |
| + | |------|-----------|-------------| |
| + | | 🟩 | **Dashboard** | Overview page with statistics | |
| + | | 📊 | **Manufacturers** | Manufacturer management | |
| + | | 🔵 | **Filaments** | Filament management | |
| + | | ⭕ | **Spools** | Spool inventory management | |
| + | | 🗂️ | **Locations** | Storage location management | |
| + | | 🖨️ | **Printers** | Printer management | |
| + | | 🛡️ | **Admin Panel** | Administration (admins only) | |
| + | |
| + | At the bottom of the sidebar you will find: |
| + | - Your **username** and **role** |
| + | - The **⚙️ settings icon** (opens personal settings) |
| + | - The **→ logout icon** (signs you out) |
| + | - **Color theme switcher** (Default / Light / Dark) |
| + | |
| + | ## Main Area (Right) |
| + | |
| + | The main area displays the content of the currently selected page. All pages follow a consistent layout: |
| + | - **Page title** top left |
| + | - **Action buttons** top right (e.g. "Add Spool") |
| + | - **Filters and search** below the title |
| + | - **Table or card view** in the main area |
| + | |
| + | ## Switching the Color Theme |
| + | |
| + | In the bottom left of the sidebar you can choose between three color themes: |
| + | - **Default** – Dark green theme (standard) |
| + | - **Light** – Light theme |
| + | - **Dark** – Dark theme |
| + | |
| + | --- |
| + | |
| + | ← [Back: Login](02-login.md) | [Next: Dashboard →](04-dashboard.md) |
| /dev/null .. docs/en/04-dashboard.md | |
| @@ 0,0 1,46 @@ | |
| + | # 4. Dashboard |
| + | |
| + | **URL:** `http(s)://url/` |
| + | |
| + |  |
| + | |
| + | The Dashboard is the FilaMan start page and provides a quick overview of your entire filament inventory. |
| + | |
| + | ## Statistics Cards (Top Row) |
| + | |
| + | | Card | Description | |
| + | |------|-------------| |
| + | | **Total Spools** | Total number of all registered spools | |
| + | | **Filaments** | Number of different filament types | |
| + | | **Low & Empty Spools** | Spools with low or empty fill levels | |
| + | | **Total Value (available)** | Total value of the available filament stock | |
| + | |
| + | ## Alert System: Low Stock Spools |
| + | |
| + | The **"Low Stock Spools"** card immediately shows whether any spools need to be reordered: |
| + | - **Green message** "All spools have sufficient filament" – no action required |
| + | - **Red message** – a list of critical or empty spools is displayed |
| + | |
| + | ## Statistics Sections |
| + | |
| + | | Section | Description | |
| + | |---------|-------------| |
| + | | **Manufacturers (non-empty)** | List of manufacturers that still have filled spools | |
| + | | **Filament Types** | Overview of the material types in use | |
| + | | **Spool Status** | Visual breakdown of spool fill levels by category | |
| + | | **Filament Statistics** | Additional filament statistics | |
| + | | **Locations** | Overview of occupied storage locations | |
| + | |
| + | ## Spool Status – Fill Level Categories |
| + | |
| + | | Status | Color | Meaning | |
| + | |--------|-------|---------| |
| + | | **Full** | Green | > 75 % fill level | |
| + | | **Normal** | Blue | 50 – 75 % | |
| + | | **Low** | Yellow | Below minimum weight | |
| + | | **Critical** | Red | < 50 % of minimum weight | |
| + | | **Empty** | Gray | 0 g – completely empty | |
| + | |
| + | --- |
| + | |
| + | ← [Back: Navigation](03-navigation.md) | [Next: Manufacturers →](05-manufacturers.md) |
| /dev/null .. docs/en/05-manufacturers.md | |
| @@ 0,0 1,41 @@ | |
| + | # 5. Manufacturers |
| + | |
| + | **URL:** `http(s)://url/manufacturers` |
| + | |
| + |  |
| + | |
| + | The Manufacturers page is where you manage all **filament manufacturers** whose products you want to track in the system. Each manufacturer can have multiple associated filaments. |
| + | |
| + | ## Table Columns |
| + | |
| + | | Column | Description | |
| + | |--------|-------------| |
| + | | **NAME** | Name of the manufacturer | |
| + | | **URL** | Manufacturer's website (clickable link) | |
| + | | **FILAMENTS** | Number of filament types registered for this manufacturer | |
| + | | **SPOOLS** | Number of spools from this manufacturer currently in stock | |
| + | | **MATERIALS** | Materials used (e.g. PLA, PETG, ABS) | |
| + | | **ACTIONS** | Edit / Delete buttons | |
| + | |
| + | ## Features |
| + | |
| + | ### Search |
| + | Use the **search bar** at the top left to filter manufacturers by name. |
| + | |
| + | ### Filter by Material |
| + | The **"All Materials"** dropdown filters the manufacturer list by a specific filament material (e.g. show only PLA manufacturers). |
| + | |
| + | ### Add a Manufacturer |
| + | Click **"Add Manufacturer"** in the top right. A dialog will open with the following fields: |
| + | - **Name** – Required: manufacturer name (e.g. "Prusament") |
| + | - **URL** – Optional website address of the manufacturer |
| + | |
| + | ### Edit a Manufacturer |
| + | Click the **pencil icon** in the **ACTIONS** column next to a manufacturer. |
| + | |
| + | ### Delete a Manufacturer |
| + | Click the **trash icon** in the **ACTIONS** column. A manufacturer can only be deleted if no filaments are assigned to it. |
| + | |
| + | --- |
| + | |
| + | ← [Back: Dashboard](04-dashboard.md) | [Next: Filaments →](06-filaments.md) |
| /dev/null .. docs/en/06-filaments.md | |
| @@ 0,0 1,46 @@ | |
| + | # 6. Filaments |
| + | |
| + | **URL:** `http(s)://url/filaments` |
| + | |
| + |  |
| + | |
| + | The Filaments page lists all **filament products** registered in your system. A filament is a product template (e.g. "Prusament PETG Galaxy Black 1.75 mm") to which physical spools are then assigned. |
| + | |
| + | ## Table Columns |
| + | |
| + | | Column | Description | |
| + | |--------|-------------| |
| + | | **DESIGNATION** | Name / designation of the filament | |
| + | | **COLORS** | Assigned colors (displayed as colored circles) | |
| + | | **TYPE** | Material type (e.g. PLA, PETG, ABS, TPU) | |
| + | | **DIAMETER** | Spool diameter in mm (e.g. 1.75 mm) | |
| + | | **MANUFACTURER** | Assigned manufacturer | |
| + | | **SPOOLS** | Number of spools in stock for this filament | |
| + | |
| + | ## Features |
| + | |
| + | ### Search |
| + | The **search bar** searches designation, color, and manufacturer simultaneously. |
| + | |
| + | ### Filters |
| + | - **All Manufacturers** – Show only filaments from a specific manufacturer |
| + | - **All Types** – Filter by material type (PLA, PETG, ABS, etc.) |
| + | - **All Colors** – Filter by color |
| + | |
| + | ### Add a Filament |
| + | Click **"Add Filament"** in the top right. The form contains: |
| + | - **Designation** – Name / designation of the filament |
| + | - **Manufacturer** – Associated manufacturer (dropdown) |
| + | - **Type** – Material type |
| + | - **Diameter** – Diameter (default: 1.75 mm) |
| + | - **Colors** – Assign one or more colors |
| + | - **Min. Weight** – Minimum weight threshold (used for low-stock alerts) |
| + | - **Price per kg** – Price for value calculation (optional) |
| + | - **Article Number** – Article number (optional) |
| + | |
| + | ### Color Management |
| + | Click **"Manage Colors"** in the top right to go to the [Color Management](12-colors.md) page, where you can create and manage colors. |
| + | |
| + | --- |
| + | |
| + | ← [Back: Manufacturers](05-manufacturers.md) | [Next: Spools →](07-spools.md) |
| /dev/null .. docs/en/07-spools.md | |
| @@ 0,0 1,55 @@ | |
| + | # 7. Spools |
| + | |
| + | **URL:** `http(s)://url/spools` |
| + | |
| + |  |
| + | |
| + | The Spools page shows your **physical filament inventory** – every individual spool you own. This is the core of FilaMan. |
| + | |
| + | ## Table Columns |
| + | |
| + | | Column | Description | |
| + | |--------|-------------| |
| + | | **ID** | Unique internal ID of the spool | |
| + | | **FILAMENT** | Assigned filament product (name + color) | |
| + | | **MANUFACTURER** | Filament manufacturer | |
| + | | **MATERIAL** | Material type (PLA, PETG, ABS, etc.) | |
| + | | **STATUS** | Current fill level status (Full / Normal / Low / Critical / Empty) | |
| + | | **REMAINING** | Remaining weight in grams | |
| + | | **LOCATION** | Current storage location of the spool | |
| + | |
| + | ## Features |
| + | |
| + | ### Search |
| + | Searches filament name, manufacturer, and other fields. |
| + | |
| + | ### Filters |
| + | FilaMan offers extensive filtering options for spools: |
| + | - **All Statuses** – Filter by fill level status |
| + | - **All Locations** – Show only spools at a specific location |
| + | - **All Manufacturers** – Filter by manufacturer |
| + | - **All Materials** – Filter by material type |
| + | |
| + | ### Group by Filament |
| + | Toggle **"Group by Filament"** to group spools by their filament product. This gives a quick overview of how many spools of each filament you have. |
| + | |
| + | ### Add a Spool |
| + | Click **"Add Spool"** in the top right. The form includes: |
| + | - **Filament** – Select the associated filament product |
| + | - **Location** – Storage location of the spool |
| + | - **Initial Weight / Remaining Weight** – Starting weight and current remaining weight in grams |
| + | - **Purchase Price** – Purchase price (optional, for value calculation) |
| + | - **Purchase Date** – Purchase date (optional) |
| + | - **Notes** – Free-text note |
| + | - **Extra Fields** – If configured by the administrator |
| + | |
| + | ### Edit / Delete a Spool |
| + | In the actions column you can: |
| + | - ✏️ **Edit** – Update spool information (e.g. remaining weight after printing) |
| + | - 🗑️ **Delete** – Remove the spool from the system |
| + | |
| + | > 💡 **Tip:** Regularly update the remaining weight of your spools so that the Dashboard and low-stock alerts show accurate values. |
| + | |
| + | --- |
| + | |
| + | ← [Back: Filaments](06-filaments.md) | [Next: Locations →](08-locations.md) |
| /dev/null .. docs/en/08-locations.md | |
| @@ 0,0 1,33 @@ | |
| + | # 8. Locations |
| + | |
| + | **URL:** `http(s)://url/locations` |
| + | |
| + |  |
| + | |
| + | The Locations page is where you manage all **storage locations** for your filament spools. These can be drawers, shelves, containers, or even printers. |
| + | |
| + | ## Table Columns |
| + | |
| + | | Column | Description | |
| + | |--------|-------------| |
| + | | **NAME** | Name of the location (e.g. "Shelf A", "Dry Box") | |
| + | | **RFID UID** | Optional RFID tag UID for automatic identification | |
| + | | **SPOOLS** | Number of spools currently stored at this location | |
| + | | **ACTIONS** | Edit / Delete | |
| + | |
| + | ## Features |
| + | |
| + | ### Add a Location |
| + | Click **"Add Location"** in the top right. Enter: |
| + | - **Name** – Name of the storage location |
| + | - **RFID UID** – (Optional) RFID chip UID, if you use RFID scanners |
| + | |
| + | ### RFID Integration |
| + | FilaMan supports RFID for storage locations. If you use an RFID scanner and chips, you can automatically assign spools to a location when the scanner sends the location's UID to FilaMan. The RFID UID is attached directly to the storage location (e.g. an RFID sticker on a drawer). |
| + | |
| + | ### Delete a Location |
| + | A location can only be deleted if no spools are currently assigned to it. |
| + | |
| + | --- |
| + | |
| + | ← [Back: Spools](07-spools.md) | [Next: Printers →](09-printers.md) |
| /dev/null .. docs/en/09-printers.md | |
| @@ 0,0 1,33 @@ | |
| + | # 9. Printers |
| + | |
| + | **URL:** `http(s)://url/printers` |
| + | |
| + |  |
| + | |
| + | The Printers page is where you manage all **3D printers** registered in FilaMan. |
| + | |
| + | ## Table Columns |
| + | |
| + | | Column | Description | |
| + | |--------|-------------| |
| + | | **NAME** | Name of the printer (e.g. "Prusa MK4 #1") | |
| + | | **MODEL** | Printer model designation | |
| + | | **DRIVER** | Printer driver / connection type | |
| + | | **STATUS** | Current operational status of the printer | |
| + | | **ACTIONS** | Edit / Delete | |
| + | |
| + | ## Features |
| + | |
| + | ### Add a Printer |
| + | Click **"Add Printer"** in the top right. The form contains: |
| + | - **Name** – Unique name for the printer |
| + | - **Model** – Model designation |
| + | - **Driver** – Driver or connection type (e.g. OctoPrint, Moonraker/Klipper) |
| + | - Additional printer-specific configuration options |
| + | |
| + | ### Printer Integration |
| + | When a printer is connected, FilaMan can automatically track filament consumption and update spool fill levels, provided the printer is integrated via a compatible API (e.g. OctoPrint or Klipper/Moonraker). |
| + | |
| + | --- |
| + | |
| + | ← [Back: Locations](08-locations.md) | [Next: Settings →](10-settings.md) |
| /dev/null .. docs/en/10-settings.md | |
| @@ 0,0 1,30 @@ | |
| + | # 10. Settings |
| + | |
| + | **URL:** `http(s)://url/settings` |
| + | |
| + |  |
| + | |
| + | Under **Settings** you can manage your personal user preferences. This page is accessible to every logged-in user. |
| + | |
| + | ## Profile Settings |
| + | |
| + | | Field | Description | |
| + | |-------|-------------| |
| + | | **Email** | Your email address (used for login) | |
| + | | **Display Name** | The name shown in the sidebar | |
| + | | **Language** | Display language of the application (e.g. English, Deutsch) | |
| + | |
| + | Click **"Save Profile"** to save your changes. |
| + | |
| + | ## Change Password |
| + | |
| + | To change your password, fill in the three fields: |
| + | 1. **Current Password** – Your current password |
| + | 2. **New Password** – The new password |
| + | 3. **Confirm New Password** – Repeat the new password to confirm |
| + | |
| + | > 🔒 **Security note:** Choose a strong password of at least 8 characters, combining uppercase and lowercase letters, numbers, and special characters. |
| + | |
| + | --- |
| + | |
| + | ← [Back: Printers](09-printers.md) | [Next: Admin Area →](11-admin.md) |
| /dev/null .. docs/en/11-admin.md | |
| @@ 0,0 1,126 @@ | |
| + | # 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: |
| + | |
| + | | 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 | |
| + | |
| + | --- |
| + | |
| + | ## 11.1 User Management (Users) |
| + | |
| + | **URL:** `http(s)://url/admin/users` |
| + | |
| + |  |
| + | |
| + | 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` |
| + | |
| + |  |
| + | |
| + | 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` |
| + | |
| + |  |
| + | |
| + | This section manages **API tokens for devices**. These are required when external devices (e.g. RFID scanners, automated systems) need to communicate with the FilaMan API. |
| + | |
| + | - **Create token** – Generate a new device token |
| + | - **Revoke token** – Disable access for a device |
| + | |
| + | --- |
| + | |
| + | ## 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. |
| + | |
| + | | Column | Description | |
| + | |--------|-------------| |
| + | | **TARGET TYPE** | Whether the field applies to filaments or spools | |
| + | | **KEY (JSON)** | Internal JSON key for the field | |
| + | | **DISPLAY LABEL** | Label shown in the user interface | |
| + | | **DEFAULT VALUE (OPTIONAL)** | Optional default value | |
| + | |
| + | 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 |
| + | |
| + | **URL:** `http(s)://url/admin/system` |
| + | |
| + |  |
| + | |
| + | The System section provides access to: |
| + | - **Plugin management** – Install and manage extensions |
| + | - **System settings** – Global configuration options |
| + | |
| + | --- |
| + | |
| + | ## 11.6 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](10-settings.md) | [Next: Color Management →](12-colors.md) |
| /dev/null .. docs/en/12-colors.md | |
| @@ 0,0 1,17 @@ | |
| + | # 12. Color Management |
| + | |
| + | Color management is accessible via the **"Manage Colors"** button on the [Filaments page](06-filaments.md). |
| + | |
| + | Colors are defined system-wide in FilaMan and can then be assigned to filaments. This allows you to filter by color and display colors consistently throughout the application. |
| + | |
| + | ## Add a Color |
| + | |
| + | Click **"Add Color"** and fill in the following fields: |
| + | - **Name** – Color name (e.g. "Black", "Galaxy Black") |
| + | - **Hex Code** – Color code for visual display (e.g. `#1A1A2E`) |
| + | |
| + | The color will then appear as a selectable option when creating or editing a filament. |
| + | |
| + | --- |
| + | |
| + | ← [Back: Admin Area](11-admin.md) | [Next: Tips & FAQ →](13-faq.md) |
| /dev/null .. docs/en/13-faq.md | |
| @@ 0,0 1,56 @@ | |
| + | # 13. Tips & FAQ |
| + | |
| + | ## ❓ How do I add a new spool? |
| + | |
| + | 1. Make sure the manufacturer is already created (→ [Manufacturers](05-manufacturers.md)) |
| + | 2. Make sure the filament product is already created (→ [Filaments](06-filaments.md)) |
| + | 3. If needed, create the storage location (→ [Locations](08-locations.md)) |
| + | 4. Go to **Spools** and click **"Add Spool"** |
| + | 5. Select the filament and location, enter the weight, and save |
| + | |
| + | --- |
| + | |
| + | ## ❓ In what order should I enter data? |
| + | |
| + | For best results, we recommend the following order: |
| + | |
| + | ``` |
| + | 1. Create manufacturers (Manufacturers) |
| + | 2. Create colors (via "Manage Colors" in Filaments) |
| + | 3. Create filament products (Filaments) |
| + | 4. Create storage locations (Locations) |
| + | 5. Create spools (Spools) |
| + | 6. Create printers (Printers) – optional |
| + | ``` |
| + | |
| + | --- |
| + | |
| + | ## ❓ What does the "Low Stock" status mean? |
| + | |
| + | Each filament has a minimum weight threshold (Min. Weight) defined when the filament is created. When a spool's remaining weight falls below this threshold, the spool is marked as **Low**. The Dashboard will then show a warning in the "Low Stock Spools" card. |
| + | |
| + | --- |
| + | |
| + | ## ❓ How do I change the color theme? |
| + | |
| + | In the bottom left of the sidebar there are buttons for **Default**, **Light**, and **Dark**. Simply click the desired theme. |
| + | |
| + | --- |
| + | |
| + | ## ❓ I can't see the Admin area – why? |
| + | |
| + | The **Admin Panel** menu item is only visible to users with the **Admin role**. If you need to perform administrative tasks, contact your system administrator to get the necessary permissions. |
| + | |
| + | --- |
| + | |
| + | ## ❓ How do I log out? |
| + | |
| + | Click the **→ arrow icon** at the bottom left of the sidebar next to the gear icon. You will be immediately signed out and redirected to the login page. |
| + | |
| + | --- |
| + | |
| + | ← [Back: Color Management](12-colors.md) | [Back to Table of Contents →](00-contents.md) |
| + | |
| + | --- |
| + | |
| + | *This manual was created for FilaMan. For technical questions or issues, please contact your system administrator.* |
| home.md .. | |
| @@ 1,28 1,49 @@ | |
| - | ## Welcome to your wiki! |
| - | |
| - | Your Otter Wiki is up and running. |
| - | |
| - | This is your [[Home]] Page, the first page you see when you access your |
| - | wiki. |
| - | |
| - | The first steps you might want to do: |
| - | |
| - | 1. [Register an account](/-/register). The very first account is an |
| - | admin account which is able to configure the wiki. |
| - | 2. Check the [configuration](/-/admin#application_preferences) of your wiki. |
| - | You can change its name, configure the permissions necessary to |
| - | view and edit pages or upload attachments. |
| - | 3. If you require users to confirm their email address (recommended), |
| - | make sure that you will configure and test your [Email Preferences](/-/admin#mail_preferences). |
| - | 4. [Edit your Home](/Home/edit)! Do not like the change? Visit the |
| - | page [history](/Home/history) and revert any change ever made. |
| - | 5. You can [attach](/Home/attachments) images and other files to any page |
| - | and then display them and link to them inside the page. |
| - | 6. [Create new pages](/-/create)! If you need help with the Markdown syntax, |
| - | check out the [Markdown guide](/-/help/syntax). |
| - | 7. Read the [user guide](/-/help) and learn about An Otter Wikis features. |
| - | |
| - | We hope that An Otter Wiki is just what you are looking for. |
| - | If you have any suggestions, feature requests or run into any |
| - | issues, please reach out and report them |
| - | via [github](https://github.com/redimp/otterwiki/issues). |
| + | # FilaMan – Filament Management System |
| + | |
| + | --- |
| + | |
| + | ## 🇩🇪 Deutsch |
| + | |
| + | **FilaMan** ist eine webbasierte Open-Source-Anwendung zur Verwaltung von **3D-Drucker-Filamenten**. Sie ermöglicht es Einzelpersonen und Teams, ihren gesamten Filamentbestand zentral zu erfassen, zu organisieren und zu überwachen. |
| + | |
| + | ### Funktionsumfang |
| + | |
| + | - **Spulenverwaltung** – Erfassen Sie jede Filamentspule mit Gewicht, Status und Lagerort |
| + | - **Füllstandsüberwachung** – Automatische Statusberechnung (Full / Normal / Low / Critical / Empty) mit Low-Stock-Warnungen auf dem Dashboard |
| + | - **Hersteller & Filamente** – Strukturierte Verwaltung von Herstellern und Filamentprodukten mit Materialtyp, Durchmesser und Farben |
| + | - **Lagerorte** – Definition von Lagerplätzen mit optionaler RFID-Integration zur automatischen Identifikation |
| + | - **Druckerintegration** – Anbindung von 3D-Druckern über OctoPrint oder Klipper/Moonraker zur automatischen Verbrauchserfassung |
| + | - **Mehrbenutzer & Rollen** – Rollenbasierte Zugriffskontrolle (Administrator, User, Viewer) mit individuell konfigurierbaren Berechtigungen |
| + | - **API & Geräte-Token** – REST-API für externe Geräte und Automatisierungen (z. B. RFID-Scanner) |
| + | - **Zusatzfelder** – Erweiterbare Datenfelder für Spulen und Filamente nach eigenen Anforderungen |
| + | - **Mehrsprachig** – Unterstützung mehrerer Anzeigesprachen |
| + | |
| + | ### Dokumentation |
| + | |
| + | 📖 **[Zum deutschen Endanwender-Handbuch](docs/de/00-inhalt)** |
| + | |
| + | --- |
| + | |
| + | ## 🇬🇧 English |
| + | |
| + | **FilaMan** is a web-based open-source application for managing **3D printer filaments**. It enables individuals and teams to centrally record, organize, and monitor their entire filament inventory. |
| + | |
| + | ### Features |
| + | |
| + | - **Spool management** – Track every filament spool with weight, status, and storage location |
| + | - **Fill level monitoring** – Automatic status calculation (Full / Normal / Low / Critical / Empty) with low-stock alerts on the Dashboard |
| + | - **Manufacturers & Filaments** – Structured management of manufacturers and filament products including material type, diameter, and colors |
| + | - **Storage locations** – Define storage places with optional RFID integration for automatic identification |
| + | - **Printer integration** – Connect 3D printers via OctoPrint or Klipper/Moonraker for automatic consumption tracking |
| + | - **Multi-user & roles** – Role-based access control (Administrator, User, Viewer) with individually configurable permissions |
| + | - **API & device tokens** – REST API for external devices and automations (e.g. RFID scanners) |
| + | - **Extra fields** – Extensible data fields for spools and filaments tailored to your needs |
| + | - **Multi-language** – Support for multiple display languages |
| + | |
| + | ### Documentation |
| + | |
| + | 📖 **[Go to the English User Manual](docs/en/00-contents)** |
| + | |
| + | --- |
| + | |
| + | *FilaMan is developed and maintained by Manuel Weiser. Licensed under the MIT License.* |