Skip to content

Getting Started

Welcome to Kamerplanter! This guide will take you from zero to a running application in just a few minutes.

Which path is right for you?

All you need is Docker on your computer. In 5 minutes you'll have Kamerplanter running and can start adding your first plants.

Continue to: Quick Start

You're planning to install Kamerplanter on a Raspberry Pi, NAS, or home server for long-term use.

Continue to: Installation and then First Deployment

How Kamerplanter works

Kamerplanter consists of several building blocks that work together:

graph LR
    A["You (Browser)"] --> B["Frontend\n(User Interface)"]
    B --> C["Backend\n(Logic & API)"]
    C --> D["Database\n(ArangoDB)"]
    C --> E["Background\nTasks\n(Celery)"]
    E --> F["Cache\n(Valkey)"]
    C --> F

    style A fill:#4CAF50,color:#fff
    style B fill:#66BB6A,color:#fff
    style C fill:#43A047,color:#fff
    style D fill:#2E7D32,color:#fff
    style E fill:#388E3C,color:#fff
    style F fill:#1B5E20,color:#fff

That sounds like a lot, but Docker Compose starts everything automatically with a single command. You don't need to set up the individual components yourself.

What to expect after starting

  1. You open Kamerplanter in your browser
  2. The Onboarding Wizard greets you and guides you through the setup
  3. You choose your experience level and a starter kit (e.g. "Windowsill Herbs" or "Balcony Tomatoes")
  4. Kamerplanter automatically creates plants, locations, and tasks for you
  5. You land on your personal dashboard

Learn more about the Onboarding Wizard in the User Guide.

In this section

Page Description Time needed
Installation Check prerequisites and install Docker 10 min
Quick Start Start Kamerplanter and add your first plants 5 min
First Deployment Run permanently on your own server 15 min