ShelfBridge can be installed using several different methods. Choose the one that best fits your environment and experience level.
| Method | Best For | Difficulty | Updates | Isolation |
|---|---|---|---|---|
| Docker Compose | Most users, home servers | Easy | Automatic | Excellent |
| Manual Docker | Custom deployments, advanced users | Medium | Manual | Excellent |
| Node.js Direct | Developers, custom integrations | Medium | Manual | None |
| From Source | Contributors, bleeding edge | Hard | Manual | None |
Perfect for:
- Home server deployments
- NAS systems (Synology, QNAP, etc.)
- Users who want "set and forget" operation
Advantages:
- Zero-configuration setup
- Automatic container management
- Easy updates
- Named volumes for data persistence
Get Started:
- Docker Setup Guide - Complete Docker installation
- Quick Start Guide - Get running in 5 minutes
Perfect for:
- Custom container orchestration
- Kubernetes deployments
- Advanced Docker users
Advantages:
- Full control over container configuration
- Custom network setups
- Integration with existing container stacks
Get Started: See the Docker Setup Guide for manual Docker commands and configurations.
Perfect for:
- Development environments
- Custom integrations
- Users who prefer direct control
Advantages:
- Direct access to source code
- Easy debugging and customization
- No containerization overhead
Get Started:
- Node.js Setup Guide - Complete Node.js installation
- Prerequisites - System requirements
Perfect for:
- Contributors and developers
- Testing unreleased features
- Custom modifications
Advantages:
- Latest development code
- Ability to modify source
- Full development environment
Get Started:
- Contributing Guide - Development setup
- Development Setup - Detailed dev environment
- Docker: Native support, excellent performance
- Node.js: Direct installation recommended
- Package managers: Use system package manager for Node.js
- Docker Desktop: Easy installation and management
- Node.js: Install via Homebrew or official installer
- Apple Silicon: Both Docker and Node.js have native ARM64 support
- Docker Desktop: Recommended for Windows 10/11
- WSL2: Excellent for Linux-like experience
- Node.js: Official Windows installer available
- Docker: Usually the best option
- Check compatibility: Ensure your NAS supports Docker
- ARM processors: Use ARM64 Docker images
- Docker Compose: Ideal for most home servers
- Portainer: Consider for Docker management UI
- Reverse proxy: Integrate with existing proxy setup
- Docker: Works on all major cloud platforms
- Container services: AWS ECS, Google Cloud Run, Azure Container Instances
- Serverless: Consider for scheduled sync operations
- Security: Review Docker security policies
- Proxy: Configure for corporate proxy servers
- Compliance: Ensure meets corporate software policies
- Export volumes:
docker-compose down && docker volume ls - Note volume paths and configurations
- Use manual Docker run with same volumes
- Backup configuration:
cp config/config.yaml config.backup - Export cache:
node src/main.js cache --export backup.json - Set up Docker with same configuration
- Import cache if needed
- Extract config:
docker exec container cat /app/config/config.yaml - Extract cache:
docker exec container node src/main.js cache --export - Set up Node.js environment
- Import configuration and cache
Once you've chosen your installation method:
- Review Prerequisites: Prerequisites Guide
- Follow Installation Guide: Method-specific setup instructions
- Configure ShelfBridge: Configuration Overview
- Test Your Setup: First Sync Guide
- Installation Issues: Troubleshooting Guide
- Configuration Help: Configuration Overview
- General Questions: FAQ
Ready to install? Choose your method and follow the corresponding guide!