Installation & Configuration

Quick Start (Docker)

My recommended way to run jotty·page is with Docker, or you can use the handy proxmox community script.

1. Copy and paste the following to create the right folders and set the right permissions:

mkdir -p config data/users data/checklists data/notes data/sharing data/encryption cache && sudo chown -R 1000:1000 data/ && sudo chown -R 1000:1000 config/ && sudo chown -R 1000:1000 cache/

2. Create your docker-compose.yml file:

services:
    jotty:
        image: ghcr.io/fccview/jotty:latest
        container_name: jotty
        user: "1000:1000"
        ports:
            - "1122:3000"
        volumes:
            - ./data:/app/data:rw
            - ./config:/app/config:rw
            - ./cache:/app/.next/cache:rw
        restart: unless-stopped
        environment:
            - NODE_ENV=production

See docs for a full guide on SSO setup

3. Start the container:

docker-compose up -d

On your first visit, you'll be redirected to /auth/setup to create your admin account.

If SSO is enabled, the first user to sign in via SSO will become the admin.

                                jotty@localhost:~$ jotty --data-storage
                            
                                    All data is stored in your data/ directory.
                                
Content:

                                        • data/checklists/ (All .md files)

                                        • data/notes/ (All .md files)

                                        • data/encryption/ (Keys)
                                    
Users & Settings:

                                        • data/users/ (users.json)

                                        • data/sharing/ (shared-items.json)

                                        • data/settings.json (App settings)
                                    
                                    ⚠ Always back up your data/ directory!
                                
                                jotty@localhost:~$ jotty --versioning
                            
                                    This project uses a [STABLE].[FEATURE].[FIX] versioning scheme.
                                
                                    Stable (1.x.x): Current stable generation. Changes only for complete rewrites.

                                    Feature (x.10.x): New features or significant changes. Automatic migrations
                                    provided.

                                    Fix (x.x.1): Hotfixes and bug fixes.
                                
                                    Feature releases may include automatic data migrations, detailed in release notes.
                                
                                jotty@localhost:~$ jotty --sso
                            
                                    Integrate with any OIDC provider (Authentik, Keycloak, etc.) by setting environment
                                    variables in your docker-compose.yml file.
                                
                                    environment:

                                      - SSO_MODE=oidc

                                      - OIDC_ISSUER=https://YOUR_SSO_HOST/issuer

                                      - OIDC_CLIENT_ID=your_client_id

                                      - APP_URL=https://your-jotty-domain.com
                                
                                    See docs for a
                                        full guide on SSO setup
                                
                                jotty@localhost:~$ jotty --docs
                            
                                    Developer & API Documentation
                                
                                    For guides on the REST API, keyboard shortcuts, and supported Markdown, please see
                                    the full documentation on GitHub.