Self-hosted knowledge keeper for 3D printing projects.
Manage and document your 3D models, print jobs, and project artifacts with a production-ready REST API. Store project metadata in the database and filesystem artifacts in your own infrastructure.
- User and access management (local authentication + OIDC/OAuth2 support)
- Project and 3D model management with filesystem-backed artifacts
- API keys for automation and integrations
- Pluggable storage and viewer systems
- Production deployment ready (Kubernetes health checks, structured logging)
- Hybrid metadata storage (database records + markdown frontmatter)
git clone https://github.com/bodybybuddha/3DKenji.git
cd 3dkenji
docker-compose upThe API runs at http://localhost:8000 with interactive docs at http://localhost:8000/docs.
git clone https://github.com/bodybybuddha/3DKenji.git
cd 3dkenji
make install
make devOpen in VS Code with the devcontainer extension for automatic setup.
Complete documentation is available in the docs/ folder:
- Getting Started – Installation and first steps
- API Reference – Complete REST API documentation
- Configuration – Environment variables and settings
- OAuth / OIDC Setup – Single sign-on configuration
- Project Storage Architecture – Filesystem layout and metadata
- Full Documentation Index – All topics
Note: This README is a landing page. See the documentation folder for detailed guides, configuration options, and API examples.
1.0.0 – Production-stable release with OAuth, API key improvements, and filesystem-backed projects.
Contributions are welcome! Please:
- Fork the repository
- Create a working branch from
devusingfeature/*,bugfix/*,docs/*, orchore/*prefix - Add tests for new features
- Run
make testto verify - Submit a pull request to
dev
See CONTRIBUTING.md for details.
MIT – See LICENSE for details.
- Documentation: docs/index.md
- Issues: GitHub Issues
- Discussions: GitHub Discussions