Files
Thingport/README.md
T
Tautvydas Derzinskas f10bd133f2 docs: update docs and site (#50)
* docs: update docs and site

* docs: image theme adaptability
2026-10-17 05:59:03 +02:00

18 KiB

Thingport

Your personal 3D model library.

Collect, organize, preview, and manage your 3D printing models
from the places where you discover them.

Website · Docs · Features · Blog

Website build Frontend Backend Slicer Bridge Thingport Grab

About

If you do 3D printing, you probably discover models across MakerWorld, Printables, Thingiverse, and other 3D model platforms.

Over time, those bookmarks, downloads, ZIP files, and random folders become a mess.

Thingport is your personal, self-hosted 3D model library.

Bring your models together in one place, keep them organized, and preview them directly in your browser.

Instead of having your collection scattered across different websites and your filesystem, Thingport gives you a single place to manage the models you actually want to keep.

Screenshots

Dashboard
Dashboard
Models
Models
Model details
Model Details
3D preview
3D Preview
Collections
Collections
A synced collection's sync configuration
Synced Collection
Tags
Tags
Downloads
Downloads
My models
My Models
Dark theme
Dark Theme
Profile with activity heatmap
Profile & Activity
Configuration, Providers section
Configuration — Providers
AI category suggestions to accept or reject
AI Categorization
An AI-improved description next to the original
Improved Descriptions
Sign-in page with a single sign-on button
Single Sign-On
Administration overview with System Health
Administration
Administration, Providers page with on/off switches
Administration — Providers
Administration, AI page with models and features
Administration — AI
Thingport Grab importing a Printables collection
Thingport Grab — Collections
Thingport Grab on Printables
Thingport Grab — Printables
Thingport Grab on Thingiverse
Thingport Grab — Thingiverse
Thingport Grab on MakerWorld
Thingport Grab — MakerWorld
Thingport Grab syncing a MakerWorld collection
Thingport Grab — Sync a Collection

Installation

Step-by-step guides for Docker Compose, Unraid, TrueNAS SCALE and CasaOS are also on the Thingport website.

Docker Compose

Runs entirely from the pre-built images on GHCR -- no local build, no git clone needed. Works on any Docker host, including a NAS (Synology, QNAP, Unraid, etc).

Unraid users: see docs/install/unraid/README.md for an Unraid-flavored compose file (appdata paths, Docker tab icons/WebUI) and Compose plugin setup steps.

TrueNAS SCALE users: see docs/install/truenas/README.md for a TrueNAS-flavored compose file (dataset-backed appdata paths) and both the Custom App (YAML) and SSH setup steps.

CasaOS users: see docs/install/casaos/README.md for a CasaOS-flavored compose file (/DATA/AppData appdata paths) and both the customized-app and SSH setup steps.

Create a folder for Thingport and add these two files to it:

docker-compose.yml
services:
  db:
    image: postgres:16-alpine
    restart: unless-stopped
    environment:
      - POSTGRES_USER=${POSTGRES_USER:-thingport}
      - POSTGRES_PASSWORD=${POSTGRES_PASSWORD:-thingport}
      - POSTGRES_DB=${POSTGRES_DB:-thingport}
    volumes:
      - thingport_db:/var/lib/postgresql/data
    networks:
      - app-net
    healthcheck:
      test: ["CMD-SHELL", "pg_isready -U ${POSTGRES_USER:-thingport}"]
      interval: 5s
      timeout: 5s
      retries: 10

  flaresolverr:
    image: ghcr.io/flaresolverr/flaresolverr:latest
    restart: unless-stopped
    environment:
      - LOG_LEVEL=${FLARESOLVERR_LOG_LEVEL:-info}
      - TZ=${TZ:-UTC}
    networks:
      - app-net

  backend:
    image: ghcr.io/tautvydasderzinskas/thingport-backend:latest
    restart: unless-stopped
    environment:
      - PUID=${PUID:-1000}
      - PGID=${PGID:-1000}
      - AUTH_SECRET=${AUTH_SECRET:-changeme-secret}
      - AUTH_TOKEN_TTL=${AUTH_TOKEN_TTL:-43200}
      - PUBLIC_URL=${PUBLIC_URL:-}
      - SMTP_HOST=${SMTP_HOST:-}
      - SMTP_PORT=${SMTP_PORT:-587}
      - SMTP_SECURE=${SMTP_SECURE:-false}
      - SMTP_USER=${SMTP_USER:-}
      - SMTP_PASS=${SMTP_PASS:-}
      - SMTP_FROM=${SMTP_FROM:-Thingport <no-reply@localhost>}
      - FILE_STORAGE=/app/storage
      - DATABASE_URL=postgresql://${POSTGRES_USER:-thingport}:${POSTGRES_PASSWORD:-thingport}@db:5432/${POSTGRES_DB:-thingport}?schema=public
      - CORS_ORIGINS=${CORS_ORIGINS:-}
      - FLARESOLVERR_URL=${FLARESOLVERR_URL:-http://flaresolverr:8191/v1}
    depends_on:
      db:
        condition: service_healthy
      flaresolverr:
        condition: service_started
    volumes:
      - thingport_storage:/app/storage
      # Optional consume folder: files and folders dropped in it are imported automatically
      # (Administration -> Storage -> Consume Folder). Uncomment and point it at a host folder.
      # - /path/to/consume:/app/consume
    networks:
      - app-net

  frontend:
    image: ghcr.io/tautvydasderzinskas/thingport-frontend:latest
    restart: unless-stopped
    ports:
      - "${WEB_PORT:-80}:80"
    depends_on:
      - backend
    networks:
      - app-net

volumes:
  thingport_storage:
  thingport_db:

networks:
  app-net:
    driver: bridge
.env
# Required
# AUTH_SECRET signs login tokens -- use your own random value
AUTH_SECRET=b1193c7014e833a063f750d6e4644d615e90e6ee81dbde619e1818e9675a3374
POSTGRES_PASSWORD=change-this-password

# Optional (defaults shown)
PUID=1000
PGID=1000
WEB_PORT=80
POSTGRES_USER=thingport
POSTGRES_DB=thingport
# e.g. https://thingport.example.com -- needed for links in emails and for single sign-on (OIDC).
# Read on the first run only; after that it's managed in Administration -> Auth.
PUBLIC_URL=
# login token lifetime, in seconds
AUTH_TOKEN_TTL=43200
SMTP_HOST=
SMTP_PORT=587
SMTP_SECURE=false
SMTP_USER=
SMTP_PASS=
SMTP_FROM=Thingport <no-reply@localhost>
# first-run default only; once Thingport has started, change it in Administration -> Connections -> FlareSolverr
FLARESOLVERR_URL=http://flaresolverr:8191/v1
TZ=UTC

Then start it:

docker compose up -d

Thingport will be available at http://<host>:<WEB_PORT> (default port 80). The first account you register becomes the admin account.

Then open Administration → Overview → System Health and click Run full test. Ideally everything is green: anything marked Required or Recommended that isn't means Thingport, or part of it, won't work properly until it's fixed, and each problem says how. It's also the first place to look whenever something stops working. See System Health.

Just want to try it? On Linux or macOS, one command creates a thingport folder with the same two files, generates the secrets in .env and starts Thingport on port 80:

curl -fsSL https://thingport.net/install.sh | sh

Edit .env there and run docker compose up -d again to change settings. Pick the folder and port up front with curl -fsSL https://thingport.net/install.sh | WEB_PORT=8080 sh -s -- ~/thingport. The script is install.sh in this repo.

Building from source instead
git clone https://github.com/TautvydasDerzinskas/Thingport.git
cd Thingport
cp .env.example .env
docker compose up -d

This builds the images locally rather than pulling from GHCR.

Consume folder

To have Thingport import whatever you drop into a folder on the server, uncomment the consume volume in docker-compose.yml. See the consume folder guide.

Features

Companion Apps

Thingport ships two small companion tools, each downloadable from the in-app Download page or GitHub Releases:

  • Thingport Bridge — a lightweight desktop helper that makes "Open in {Slicer}" work for slicers (Bambu Studio, PrusaSlicer, Cura, Anycubic Slicer Next) whose own URL-protocol handlers won't accept a link from a self-hosted domain.
  • Thingport Grab — a browser extension for Chrome, Edge and Firefox that imports MakerWorld, Thingiverse, and Printables models straight from their own pages, without leaving the site (see the screenshots above). Even without a Thingport instance, it adds a "Download normalized" button to MakerWorld model pages that converts Bambu Studio projects into 3MFs other slicers open with their colours and settings. Get it from the Chrome Web Store, Firefox Add-ons or Microsoft Edge Add-ons.

Provider Setup

Printables imports work with no setup. MakerWorld and Thingiverse each need a credential from your own account first. Connect them under Configuration → Providers (from the user menu): right-click a provider to connect or disconnect it. Admins can turn any provider off for the whole instance under Administration → Providers. See docs/PROVIDER_SETUP.md for how to create a Thingiverse Access Token and how to grab a MakerWorld session cookie.

Contributing

Bug reports and pull requests are welcome. See CONTRIBUTING.md for the branch, commit and pull request workflow, and docs/DEVELOPMENT.md for how to run Thingport locally with hot reload.

Honourable contributors

Rui Valim
Ruivalim
GitHub  Website  LinkedIn

Support

If Thingport is useful to you, consider supporting its development:

License

Thingport is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License, version 3 (AGPL-3.0-only), as published by the Free Software Foundation.