Sign in
Enter the admin password to manage libraries, upload, edit and delete.
Libraries
Folders with 3D files. Each library appears in the library menu on the main page.
Thumbnails & previews
The server renders thumbnails in the background and builds compressed previews of large models, so the gallery and viewer load faster.
Files that could not be rendered
Storage
How much space the thumbnails, previews and trash take, and how much is free where they are kept.
- Loading…
Duplicates
Models stored more than once, in any folder or library: the same size and the same contents, whatever their names. Send the copies you do not need to the trash.
Printers
Printers on your network that sliced files (G-code, sliced 3MF) can be sent to, from the viewer and the To print list. The admin and accounts with Can print (on the Accounts tab) use them.
Notifications
A short message when something happens. Turn on one or more ways to receive them; Send a test checks the settings.
Telegram
Create a bot with @BotFather and paste its token; send the bot a message, then use your chat ID (or a group's, starting with -100).
Discord
Channel settings → Integrations → Webhooks → New webhook → Copy webhook URL.
Through your mail provider's SMTP server (for Gmail: smtp.gmail.com, port 465 with "SSL", and an app password).
ntfy
A topic on ntfy.sh or your own ntfy server; subscribe to it in the ntfy app.
Gotify
In Gotify: Apps → Create application, and copy its token.
Install as an app
People can install 3D Viewer on their computer, phone or tablet with Install app (the phone icon at the top of the main page): it then has its own icon and opens in its own window. Chrome, Edge and Android only install apps from an https:// address; iPhone and iPad (Share → Add to Home Screen) work over http too. The icon below is used for the app, the browser tab and the logo; apps already installed may keep the old icon until they are installed again.
Ideas and bug reports
Suggestions and problem reports go to the public 3D Viewer page on GitHub (a free GitHub account is needed to post). Ideas others like most are built first.
Import from link
Accounts and the admin import models with Import at the top of the main page: a model page on Printables, Thingiverse or MakerWorld, or a link to a file. Thingiverse only answers apps with a token: create an app at thingiverse.com/apps/create (type "Web App") and paste its App Token here.
API tokens
Tokens people made for scripts and Home Assistant (person menu → API tokens on the main page). A token acts as the person who made it. Remove stops it at once.
Share links
Links to a model or a folder that anyone can open without an account (also on a private server). Accounts and the admin make them with Share link in the viewer or Share above a folder. Remove stops a link at once.
Limits
Sizes are in MB (1024 MB = 1 GB). A value set in docker-compose.yml (MAX_UPLOAD_MB, MAX_UNZIP_MB, MAX_RENDER_MB) is used instead and shown locked here.
Trash
Files and folders deleted in the library wait here, in a hidden .3dviewer-trash folder of their library. Restore puts an item back where it was, with its notes and orientation.
Viewer defaults
Print cost
Prices for Weight & cost in the viewer. Everyone sees these; each person can still change a price for themselves there.
| Material | Density | Price per kg |
|---|
Supporter license
Accounts
People who sign in on the main page (the person button at the top) get their own favourites, tags and print log. Accounts can look at and download models; only the admin can change the library.
Everyone can turn on two-factor sign-in for themselves in the person menu on the main page (the admin too: sign in there as admin). A lost phone: Reset 2FA below for an account; for the admin, set ADMIN_RESET_2FA=true in the container settings once.
Single sign-on
Let people sign in with your login provider (Authelia, Authentik, Keycloak, Zitadel, Pocket ID… anything with OpenID Connect). In the provider, add an application (client) with the redirect URI below; then enter its details here. Accounts are made the first time someone signs in; user names and passwords keep working.
Redirect URI to enter in the provider:
Backup
One file with the settings of this 3D Viewer: libraries, network shares (with their passwords), all settings, the admin password, the accounts with their favourites, tags and print logs, and the supporter key. Your models, their notes and the thumbnails are not in it. Keep it somewhere safe.
Automatic backups
No folder chosen
Pick a folder on another disk or a network share, so a backup survives if the NAS disk with 3D Viewer's data fails. Older backups in the folder beyond the number to keep are deleted; other files are left alone.
Access & editing
Editing is locked by READ_ONLY=true in the container settings.