Quick Start

Getting Started

The easiest way to get started using Grimoire is to clone the repository, create the .env file with personalized settings, and run the docker compose up command. This will pull the latest Docker image and run it on your local machine.

Prerequisites

• Docker
• Docker Compose

Steps

1. Clone the repository

git clone https://github.com/goniszewski/grimoire

tip

For the recommended setup, only the docker-compose.yml file is needed.

2. Review the docker-compose.yml file

Though no action may be required, it's recommended to review the docker-compose.yml file to ensure that the settings do meet your needs.

services:
  grimoire:
    image: goniszewski/grimoire:develop
    container_name: grimoire
    restart: unless-stopped
    environment:
      - PORT=5173
      - PUBLIC_HTTPS_ONLY=false
      - PUBLIC_SIGNUP_DISABLED=false
    volumes:
      - grimoire_data:/app/data/
    build:
      context: .
      dockerfile: Dockerfile
    healthcheck:
      test: wget --no-verbose --tries=1 --spider http://localhost:$PORT/api/health || exit 1
      interval: 30s
      timeout: 10s
      retries: 3
    ports:
      - '${PORT:-5173}:${PORT:-5173}'
volumes:
  grimoire_data:

3. Pull and run the container

Now we'll use the Docker Compose to pull the containers and run the application:

docker compose up # add -d to run in the background

4. Open the application in your browser

Congratz! You can now go to http://localhost:5173 (if not changed in the environment part of the compose file) and start using Grimoire!

PS. Grimoire is even better when you use it with our official browser extension:

Next Steps

• Development