docs

README

Immich-Go Documentation

Welcome to the complete documentation for Immich-Go, an open-source tool for uploading and managing photo collections with your self-hosted Immich server.

📖 Documentation Overview

This documentation is organized into several sections to help you get started quickly and master advanced features:

🚀 Getting Started

• Installation - Complete installation guide for all platforms
• Examples - Common use cases and practical examples
• Configuration - Environment variables and configuration options

📝 Command Reference

• Commands Overview - Complete command structure and global options
• Upload Commands - Detailed upload command documentation
• Archive Commands - Export and archival operations
• Stack Commands - Photo organization and stacking

📋 Best Practices & Advanced Topics

• Best Practices - Performance tips and optimization strategies
• Technical Details - File processing, metadata handling, and internals
• Environment Setup - Advanced environment configuration

🔧 Specialized Topics

• Concurrency - Multi-threading and performance optimization
• Miscellaneous - Additional guides and troubleshooting

🎯 Quick Navigation by Use Case

New Users

1. Start with Installation to set up Immich-Go
2. Review Examples for your specific use case
3. Check Best Practices for optimal performance

Google Photos Migration

• Google Photos Takeout Guide
• Migration Best Practices
• Upload from Google Photos

Advanced Users

• Technical Details for deep dive into functionality
• Configuration for advanced customization
• Concurrency for performance optimization

🛠 Common Commands Quick Reference

# Upload from local folder
immich-go upload from-folder --server=SERVER --api-key=KEY /path/to/photos

# Upload Google Photos takeout
immich-go upload from-google-photos --server=SERVER --api-key=KEY /path/to/takeout.zip

# Archive from Immich server
immich-go archive from-immich --server=SERVER --api-key=KEY --write-to-folder=/archive

# Stack similar photos
immich-go stack --server=SERVER --api-key=KEY

📚 Documentation Structure

docs/
├── README.md                    # This file - documentation hub
├── installation.md              # Installation guide
├── configuration.md             # Configuration options
├── environment.md              # Environment setup
├── examples.md                 # Practical examples
├── best-practices.md           # Performance and reliability tips
├── technical.md                # Technical details and internals
├── commands/                   # Command reference
│   ├── README.md              # Command overview
│   ├── upload.md              # Upload commands
│   ├── archive.md             # Archive commands
│   └── stack.md               # Stack commands
├── concurrency/               # Performance optimization
│   ├── README.md             # Concurrency overview
│   └── multi-threading.md    # Threading details
└── misc/                      # Additional guides
    ├── README.md             # Miscellaneous topics index
    ├── google-takeout.md     # Google Photos migration
    ├── motivation.md         # Project background
    └── troubleshooting.md    # Common issues and solutions

🆘 Getting Help

• Documentation Issues: Something unclear? Open an issue
• Bug Reports: Found a problem? Report it
• Feature Requests: Have an idea? Share it
• Debug Information: Need to send logs? See how to send debug data

🤝 Contributing to Documentation

Documentation improvements are always welcome! See our contributing guidelines for details on:

• Fixing typos or errors
• Adding examples
• Improving clarity
• Adding new sections

📄 License

This documentation is part of the Immich-Go project and is licensed under the same terms as specified in the LICENSE file.

---

Ready to get started? Begin with the Installation Guide or jump to Examples for your specific use case.