Installation

Installation

Prerequisites

• Docker (v20+) or Podman (v4+) with Compose support
• ~1GB disk space for images
• No other software required — everything runs in containers

Step 1: Clone the Repository

git clone https://github.com/XKlibure/home-library.git
cd home-library

Step 2: Create Environment File

cp .env.example .env

Generate secure secrets:

# On macOS/Linux:
sed -i '' "s|CHANGE_ME_GENERATE_STRONG_PASSWORD|$(openssl rand -base64 24)|" .env
sed -i '' "s|CHANGE_ME_GENERATE_WITH_openssl_rand_base64_48|$(openssl rand -base64 48)|" .env
sed -i '' "s|CHANGE_ME_GENERATE_WITH_openssl_rand_base64_32|$(openssl rand -base64 32)|" .env

Or manually edit .env and replace the CHANGE_ME values with strong random strings.

Step 3: (Optional) Add Gemini API Key

For AI-powered book scanning:

1. Go to https://aistudio.google.com/apikey
2. Click Create API Key (free, no credit card)
3. Add to .env:

   GEMINI_API_KEY=AIzaSy...your-key

Step 4: Build and Start

With Docker:

docker compose up -d --build

With Podman:

podman compose up -d --build

First build takes 3-5 minutes (downloads dependencies, builds images).

Step 5: Access the App

Open http://localhost:3000 in your browser.

Default credentials:

Field	Value
Username	admin
Password	Admin1234!

⚠️ Change this password immediately via ⚙️ Settings.

Updating

git pull
docker compose up -d --build

Uninstalling

# Stop and remove containers + data
docker compose down -v

# Remove images
docker rmi $(docker images 'home-library*' -q)

Platform Notes

macOS (Apple Silicon)

Works out of the box with Docker Desktop or Podman.

Windows (WSL2)

Use Docker Desktop with WSL2 backend, or install Podman in WSL2.

Linux

# Install Docker
curl -fsSL https://get.docker.com | sh
sudo usermod -aG docker $USER

# Or install Podman
sudo apt install podman podman-compose

---

Next: Configuration