Welcome to Printventory!

Quick Start Guide

Page 1 of 5
Guide Image

Theme Settings

Change the overall color scheme of the application
Background color for 3D model thumbnails

Note: These settings are for STLs and 3MFs without embedded data.

Color of the 3D model in thumbnails
Adds ambient and directional lighting for better depth. Disabling may improve performance on lower-end devices.

Printventory Guide

Getting Started

Click the "Scan Directory" button to select a folder containing your 3D model files (.stl and .3mf). Printventory will scan and catalog your models.

Managing Models

  • View Models: Browse your models in the grid view. Each model shows a 3D preview thumbnail.
  • Edit Details: Click a model to open its details panel where you can edit:
    • Designer name
    • Source URL
    • Parent model
    • Tags
    • Print status
    • Notes
  • Bulk Edit: Select multiple models using checkboxes to edit their details simultaneously.

Features

  • Filtering: Use the dropdown menus to filter models by Designer, Parent model, or Tags.
  • Tags: Create and assign tags to organize your models. Click the (+) button to add new tags.
  • Thumbnails: Use Settings > Purge Thumbnails to regenerate model previews if needed.

Tips

  • Use the Reload option in the File menu if the application needs refreshing.
  • Join our Discord community for support and updates!

Printventory

Version: Loading...

πŸ“Š

Usage Reporting

Help improve Printventory by allowing collection of basic usage data. No personal information is collected. Reload the application to apply this setting.

πŸ“œ

Terms of Service

Printventory is licensed under the MIT License:

  • Free to use, copy, modify, merge, publish, distribute, sublicense, and/or sell.
  • Must include copyright and permission notices in all copies.
  • Software provided "as is" without warranty.
  • Authors not liable for claims, damages, or other liability.
  • You are responsible for backing up your data.

See LICENSE.txt for full text.

Keyboard Shortcuts

Power-user and accessibility shortcuts. Use Ctrl on Windows/Linux and ⌘ on Mac unless noted.

Focus searchCtrl+/
Scan directoryCtrl+Shift+S
Clear all filtersCtrl+Shift+C
Print RouletteCtrl+Shift+R
Toggle Multi-Edit modeCtrl+E
Select all (filtered) modelsCtrl+A
Next model (detail view)↓ or J
Previous model (detail view)↑ or K
Exit Multi-Edit modeEscape
Show this shortcuts dialogCtrl+Shift+?

Server Mode Information

What is Server Mode?

Server Mode allows you to run Printventory as a web server that can be accessed from any browser on your network. This is useful for accessing your 3D model library from multiple computers or devices without installing the application on each one.

Server Mode runs Printventory as an HTTP server on port 5000, making it accessible from any device on your local network through a web browser.

How to Start in Server Mode

To start Printventory in Server Mode, launch it with the --server flag:

  • Windows: printventory.exe --server
  • Command Line: printventory --server

The server will start and continue running until you close the application.

Important Requirements

  • Server Mode requires UNC (Universal Naming Convention) paths for all file operations
  • UNC paths use the format: \\\\server\\share\\path\\to\\file
  • Local drive paths (C:\, D:\, etc.) will not work in Server Mode
  • The server runs on port 5000 and listens on all network interfaces (0.0.0.0)

Accessing the Server

Once started, you can access Printventory from any browser on your network:

http://<your-computer-ip>:5000

For example, if your computer's IP address is 192.168.1.100:

http://192.168.1.100:5000

Docker Deployment (Linux)

Printventory can be deployed as a Docker container for easy server mode deployment on Linux systems.

Quick Start:

Build and run with Docker Compose:

docker-compose up -d

Or build and run manually:

docker build -t printventory:latest .
docker run -d --name printventory-server -p 5000:5000 -v printventory-data:/root/.config/Printventory printventory:latest

Accessing Network Shares:

Docker containers cannot directly access Windows UNC paths. You need to mount network shares:

  1. Mount SMB/CIFS share on host:
    sudo mount -t cifs //server/share /mnt/network-share -o username=user,password=pass
  2. Add to docker-compose.yml:
    volumes:
      - /mnt/network-share:/mnt/network-share:ro
  3. Use Linux paths in Printventory: /mnt/network-share/path/to/files

Note: When running in Docker, the application automatically accepts Linux-style absolute paths (starting with /) instead of requiring UNC paths.

For detailed Docker deployment instructions, see the README.md file.

Library Statistics

Total Models

0
Archived: 0

Model Types

3MF: 0
STL: 0
Other: 0

Metadata Completion

Designer: 0%
Parent: 0%
License: 0%
Tags: 0%

Tags

Total: 0
Most Used: -

Backup/Restore

Database

Create a backup of your database to save your model information and settings.

Restore your database from a previous backup. This will replace all current data.

Library

Export your library (models and tags) as a JSON file for backup or sharing.

Import a library JSON file to merge models and tags into your current library.

Tag Manager

Metadata Editor

System Report

Loading system information...

Manage Thumbnails

Select a thumbnail to set it as active, or delete thumbnails (the active thumbnail cannot be deleted).