Repository navigation
Installation Bare Metal
If you prefer not to use Docker, Bindarr provides prebuilt self-contained server binaries for Windows, Linux, and macOS, as well as instructions to build and run directly from source.
Prebuilt binaries bundle Node.js, the backend API server, native image libraries, and the compiled React frontend into a portable archive.
Download the appropriate archive for your operating system from the Latest GitHub Release:
| Operating System | Architecture | Archive Package |
|---|---|---|
| Windows | x64 | Bindarr-Server-windows-x64.zip |
| Linux | x64 | Bindarr-Server-linux-x64.tar.gz |
| macOS | Apple Silicon (arm64) | Bindarr-Server-macos-arm64.tar.gz |
- Download and extract
Bindarr-Server-windows-x64.zipto your preferred folder (e.g.C:\Bindarr). - (Optional) Create a
.envfile in the folder to customize ports or API keys (see Docker Configuration). - Double-click
bindarr-server.exeto start the server. - Open your browser and navigate to
http://localhost:3001.
- Extract the tarball:
tar -xzf Bindarr-Server-linux-x64.tar.gz -C /opt/bindarr cd /opt/bindarr - Make the binary executable:
chmod +x bindarr-server
- Run the binary:
./bindarr-server
- Access the web interface at
http://localhost:3001.
- Extract the tarball:
tar -xzf Bindarr-Server-macos-arm64.tar.gz cd Bindarr-Server-macos-arm64 chmod +x bindarr-server - Start the server:
./bindarr-server
- Open
http://localhost:3001in Safari or Chrome.
Running directly from source requires Node.js 18.x or higher and npm 9.x or higher.
git clone https://github.com/thenotoriousJeremy/bindarr.git
cd bindarrInstall root, backend, and frontend dependencies in one command:
npm run install:allFetch the ONNX scanning models:
cd backend
node scripts/fetch-models.mjs --catalogs
cd ..npm run dev-
Frontend:
https://localhost:5173(Vite dev server with hot reload and self-signed HTTPS for camera access). -
Backend API:
http://localhost:3001.
# Build the production frontend assets
npm run build --workspace=frontend
# Start production server
npm start --workspace=backendTo keep Bindarr running in the background and automatically restart on server reboots, create a systemd service unit.
Create /etc/systemd/system/bindarr.service:
[Unit]
Description=Bindarr Trading Card Collection Manager
After=network.target
[Service]
Type=simple
User=bindarr
Group=bindarr
WorkingDirectory=/opt/bindarr
ExecStart=/opt/bindarr/bindarr-server
Restart=always
RestartSec=5
Environment=PORT=3001
Environment=HTTPS_PORT=3443
Environment=DB_PATH=/opt/bindarr/data/bindarr.db
Environment=CV_MODEL_DIR=/opt/bindarr/data/models
Environment=TRUST_PROXY=1
[Install]
WantedBy=multi-user.targetEnable and start the service:
sudo systemctl daemon-reload
sudo systemctl enable --now bindarr
sudo systemctl status bindarrBindarr is licensed under the MIT License.
Need help? Check Troubleshooting & FAQ or open an issue on GitHub.