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 along with a PocketBase container.
Prerequisites
Steps
1. Clone the repository
git clone https://github.com/goniszewski/grimoire
For the recommended setup, only the docker-compose.yml, .env.example files and the pb_migrations/ directory (containing the migration files) are needed.
2. Rename the .env.example file to .env
mv .env.example .env # on Linux/MacOS
# or
ren .env.example .env # on Windows
The default .env file will look like this:
# Set it if you're using external PocketBase installation (default: http://pocketbase)
# Example: PUBLIC_POCKETBASE_URL=https://grimoire.mydomain.com:8090
PUBLIC_POCKETBASE_URL=
# RECOMMENDED: Change this to your email
ROOT_ADMIN_EMAIL=admin@grimoire.localhost
# RECOMMENDED: Use a secure password. Can be later changed in PocketBase's admin panel
ROOT_ADMIN_PASSWORD=changeme
# Set this to your domain name (default: http://localhost:5173)
# Example: PUBLIC_ORIGIN=grimoire.mydomain.com
PUBLIC_ORIGIN=http://localhost:5173
# Set this to true if you're using HTTPS (default: false)
# Example: PUBLIC_HTTPS_ONLY=true
PUBLIC_HTTPS_ONLY=
# Change to the port you want the app to listen on (default: 5173)
# Example: PORT=80
PORT=5173
# Set this to true if you want to disable public signups (default: false)
PUBLIC_SIGNUP_DISABLED=false
3. [RECOMMENDED] Update the .env to set the initial admin user credentials
Please remember: admins are separate from regular users and are authenticated using /admin/login path.
For more information, please refer to the Admins vs Users section.
3. Pull and run the containers
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 .env file) and start using Grimoire!
PS. Grimoire is even better when you use it with our official browser extension:
