{"id":45520780,"url":"https://github.com/akifbayram/openbin","last_synced_at":"2026-04-01T16:41:05.230Z","repository":{"id":338731061,"uuid":"1158547856","full_name":"akifbayram/openbin","owner":"akifbayram","description":"Self-hosted inventory system for organizing physical storage bins. Print labels, scan to find contents, and optionally plug in your own AI to do the heavy lifting: snap a photo and it names the bin, lists every item, and tags it for search. ","archived":false,"fork":false,"pushed_at":"2026-03-26T03:20:14.000Z","size":16689,"stargazers_count":2,"open_issues_count":10,"forks_count":1,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-03-26T08:58:26.131Z","etag":null,"topics":["ai","bins","foss","home-inventory","home-inventory-manager","home-organization","inventory","mcp","mcp-server","open-source","self-hosted","sqlite"],"latest_commit_sha":null,"homepage":"https://docs.openbin.app/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/akifbayram.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-02-15T15:00:31.000Z","updated_at":"2026-03-26T03:20:18.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/akifbayram/openbin","commit_stats":null,"previous_names":["akifbayram/sanduk","akifbayram/openbin"],"tags_count":7,"template":false,"template_full_name":null,"purl":"pkg:github/akifbayram/openbin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akifbayram%2Fopenbin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akifbayram%2Fopenbin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akifbayram%2Fopenbin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akifbayram%2Fopenbin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/akifbayram","download_url":"https://codeload.github.com/akifbayram/openbin/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akifbayram%2Fopenbin/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31290538,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-01T13:12:26.723Z","status":"ssl_error","status_checked_at":"2026-04-01T13:12:25.102Z","response_time":53,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ai","bins","foss","home-inventory","home-inventory-manager","home-organization","inventory","mcp","mcp-server","open-source","self-hosted","sqlite"],"created_at":"2026-02-22T22:49:22.543Z","updated_at":"2026-04-01T16:41:05.224Z","avatar_url":"https://github.com/akifbayram.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n  \u003cp\u003e\n    \u003ca href=\"https://demo.openbin.app\"\u003e\u003cimg alt=\"Demo\" src=\"https://img.shields.io/badge/Demo-Live-f97316?style=for-the-badge\u0026logo=googlechrome\u0026logoColor=white\" /\u003e\u003c/a\u003e\u0026nbsp;\n    \u003ca href=\"https://akifbayram.github.io/openbin/\"\u003e\u003cimg alt=\"Docs\" src=\"https://img.shields.io/badge/Docs-Site-green?style=for-the-badge\u0026logo=readthedocs\u0026logoColor=white\" /\u003e\u003c/a\u003e\u0026nbsp;\n    \u003ca href=\"https://github.com/akifbayram/openbin/actions/workflows/ci.yml\"\u003e\u003cimg alt=\"Build\" src=\"https://img.shields.io/github/actions/workflow/status/akifbayram/openbin/ci.yml?style=for-the-badge\u0026logo=githubactions\u0026logoColor=white\u0026label=Build\" /\u003e\u003c/a\u003e\u0026nbsp;\n    \u003ca href=\"https://github.com/akifbayram/openbin/releases/latest\"\u003e\u003cimg alt=\"GitHub release\" src=\"https://img.shields.io/github/v/release/akifbayram/openbin?style=for-the-badge\u0026logo=github\u0026color=blue\" /\u003e\u003c/a\u003e\u0026nbsp;\n    \u003ca href=\"https://discord.gg/W6JPZCqqx9\"\u003e\u003cimg alt=\"Discord\" src=\"https://img.shields.io/discord/1476024745886744739?style=for-the-badge\u0026logo=discord\u0026logoColor=white\u0026label=Discord\u0026color=5865F2\" /\u003e\u003c/a\u003e\u0026nbsp;\n  \u003c/p\u003e\n\n\u003cpicture\u003e\n  \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"public/logo-horizontal-dark.svg\" /\u003e\n  \u003csource media=\"(prefers-color-scheme: light)\" srcset=\"public/logo-horizontal.svg\" /\u003e\n  \u003cimg src=\"public/logo-horizontal.svg\" alt=\"OpenBin\" height=\"64\" /\u003e\n\u003c/picture\u003e\n\n\u003cp\u003eInventory with intelligence. Organize physical storage bins with QR codes, photo recognition, and multi-user collaboration.\u003c/p\u003e\n\n\n  \u003cimg src=\"docs/assets/bins.png\" alt=\"OpenBin dashboard showing bins organized by area\" width=\"700\" /\u003e\n\n\u003c/div\u003e\n\n## Features\n\n- **AI assisted autofill** — Capture photos, and the assistant autofills the items in each bin. Bring your own AI.\n- **Natural language commands** — \"Add batteries to the tools bin\" or \"Create a bin with widgets x, y, and z\".\n- **AI reorganization** — Let the assistant suggest how to restructure an entire location's bins, areas, and tags in bulk.\n- **Print \u0026 scan QR labels** — Generate customizable QR label sheets or name cards, stick them on bins, scan to see contents.\n- **MCP server included** — Connect AI assistants directly to your inventory via Model Context Protocol\n- **Data portability** — Full JSON/CSV/ZIP export with photos.\n\n## Quick Start\n\nCreate a `docker-compose.yml`:\n\n```yaml\nservices:\n  openbin:\n    image: ghcr.io/akifbayram/openbin:latest\n    ports:\n      - \"1453:1453\"\n    volumes:\n      - api_data:/data\n    environment:\n      DATABASE_PATH: /data/openbin.db\n      PHOTO_STORAGE_PATH: /data/photos\n      BACKUP_PATH: /data/backups\n\nvolumes:\n  api_data:\n```\n\n```bash\ndocker compose up -d\n```\n\nOpen `http://localhost:1453`. Register an account, create a location, and start adding bins.\n\n## Configuration\n\nAll settings are optional. Set environment variables or create a `.env` file to override defaults. See [`.env.example`](.env.example) for the full list.\n\n\u003cdetails\u003e\n\u003csummary\u003eEnvironment variables\u003c/summary\u003e\n\n| Variable | Description | Default |\n|----------|-------------|---------|\n| **Server** | | |\n| `PORT` | Express server port | `1453` |\n| `HOST_PORT` | Docker external port | `1453` |\n| `DATABASE_PATH` | SQLite database file path | `./data/openbin.db` |\n| `PHOTO_STORAGE_PATH` | Photo upload directory | `./data/photos` |\n| `TRUST_PROXY` | Set `true` when behind a reverse proxy | `false` |\n| `CORS_ORIGIN` | CORS origin (only needed for non-Docker dev setups) | `http://localhost:5173` |\n| **Authentication** | | |\n| `JWT_SECRET` | JWT signing secret; auto-generated and persisted if unset | — |\n| `ACCESS_TOKEN_EXPIRES_IN` | Short-lived access token lifetime | `15m` |\n| `REFRESH_TOKEN_MAX_DAYS` | Refresh token lifetime in days (1–90) | `7` |\n| `COOKIE_SECURE` | Force Secure flag on cookies (auto in production) | — |\n| `BCRYPT_ROUNDS` | Password hashing rounds (10–31) | `12` |\n| `REGISTRATION_MODE` | Registration policy: `open`, `invite` (require location invite code), or `closed` | `open` |\n| **Uploads** | | |\n| `MAX_PHOTO_SIZE_MB` | Max photo upload size in MB (1–50) | `5` |\n| `MAX_AVATAR_SIZE_MB` | Max avatar upload size in MB (1–10) | `2` |\n| `MAX_PHOTOS_PER_BIN` | Max photos per bin (1–100) | `1` |\n| `UPLOAD_QUOTA_DEMO_MB` | Per-user upload quota in demo mode | `5` |\n| `UPLOAD_QUOTA_GLOBAL_DEMO_MB` | Global upload quota in demo mode | `50` |\n| **AI (server-wide fallback)** | | |\n| `AI_PROVIDER` | `openai`, `anthropic`, `gemini`, or `openai-compatible` | — |\n| `AI_API_KEY` | API key for the configured provider | — |\n| `AI_MODEL` | Model name (e.g. `gpt-5-mini`, `claude-sonnet-4-6`) | — |\n| `AI_ENDPOINT_URL` | Custom endpoint for `openai-compatible` provider | — |\n| `AI_ENCRYPTION_KEY` | Encrypts user AI API keys at rest (AES-256-GCM) | — |\n| **Backups** | | |\n| `BACKUP_ENABLED` | Enable automatic database backups | `false` |\n| `BACKUP_INTERVAL` | Backup schedule (hourly/daily/weekly/cron) | `daily` |\n| `BACKUP_RETENTION` | Number of backup files to keep (1–365) | `7` |\n| `BACKUP_PATH` | Directory for backup files | `./data/backups` |\n| `BACKUP_WEBHOOK_URL` | Webhook URL for backup notifications | — |\n| **QR Code Payload** | | |\n| `QR_PAYLOAD_MODE` | QR encoding mode: `app` (openbin:// URI) or `url` (web URL) | `app` |\n| `BASE_URL` | Full URL for `url` mode (e.g. `https://inventory.example.com`) | — |\n| **Rate Limiting** | | |\n| `AI_RATE_LIMIT` | Max AI requests per hour per user | `30` |\n| `AI_RATE_LIMIT_API_KEY` | Max AI requests per hour per API key | `1000` |\n| `DISABLE_RATE_LIMIT` | Set `true` to disable all rate limiters (dev only) | `false` |\n\n\u003c/details\u003e\n\n## Architecture\n\nSingle Node.js process. All data lives in one SQLite file and a photos directory.\n\n| Layer | Technology |\n|-------|------------|\n| Frontend | React 18, TypeScript, Vite 5, Tailwind CSS 4 |\n| Backend | Express 4, SQLite (better-sqlite3), JWT auth |\n| Container | Single-stage Alpine image, runs as non-root `node` user |\n\nThe `/data` Docker volume contains everything persistent:\n\n```\n/data\n├── openbin.db        ← single database file (WAL journal)\n├── .jwt_secret       ← auto-generated if JWT_SECRET unset\n├── photos/           ← uploaded images\n└── backups/          ← scheduled DB snapshots (opt-in)\n```\n\n## API Documentation\n\nOpenAPI spec at [`server/openapi.yaml`](server/openapi.yaml). See the full [API reference](https://akifbayram.github.io/openbin/api/) in the docs.\n\n## Local Development\n\n**Prerequisites:** Node.js 20+\n\n```bash\nnpm install                 # Install frontend dependencies\ncd server \u0026\u0026 npm install    # Install server dependencies\n```\n\n```bash\nnpm run dev:all            # Both servers concurrently (recommended)\n# Or separately in two terminals:\n# cd server \u0026\u0026 npm run dev   API server at http://localhost:1453\n# npm run dev                Frontend dev server at http://localhost:5173\n```\n\n## AI Disclosure\n\nMost of this codebase—features, tests, documentation—was written by AI. A human directs architecture, priorities, and design decisions but has not reviewed most code line-by-line. Type checking, linting, and an automated test suite are the primary quality gates.\n\n## License\n\n[AGPL-3.0](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fakifbayram%2Fopenbin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fakifbayram%2Fopenbin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fakifbayram%2Fopenbin/lists"}