Installation

Installation Guide

This guide will walk you through installing jotty·page using Docker (recommended) or running it locally for development.

Docker Installation (Recommended)

Prerequisites

• Docker and Docker Compose installed
• Basic command line knowledge
• Port 1122 available (or choose another port)

Step 1: Create Docker Compose File

Create a new directory for your jotty·page installation and create a 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:ro
      - ./cache:/app/.next/cache:rw
    restart: unless-stopped
    environment:
      - NODE_ENV=production

Step 2: Create Required Directories

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

Note: The cache directory is optional. If you don't want cache persistence, you can comment out the cache volume line in your docker-compose.yml.

Step 3: Start the Container

docker-compose up -d

Step 4: Access the Application

Open your web browser and navigate to:

http://localhost:1122

You'll be redirected to the setup page to create your first admin account.

Alternative Installation Methods

Podman / Rootless Docker

If you're using Podman or rootless Docker, add this line to your docker-compose.yml:

services:
  jotty:
    # ... other settings ...
    userns_mode: keep-id

This preserves the user namespace when mounting volumes, preventing permission issues.

ARM64 Systems (Raspberry Pi, Apple Silicon)

Uncomment the platform line in your docker-compose.yml:

services:
  jotty:
    # ... other settings ...
    platform: linux/arm64

Local Development Installation

For development purposes, you can run jotty·page directly with Node.js.

Prerequisites

• Node.js 18 or higher
• Yarn package manager

Installation Steps

1. Clone the Repository

   git clone https://github.com/fccview/jotty.git
   cd jotty

2. Install Dependencies

   yarn install

3. Run Development Server

   yarn dev

4. Access the Application

   http://localhost:3000
   

Updating

Docker

Pull the latest image and restart:

docker-compose pull
docker-compose up -d

Local Development

git pull
yarn install
yarn build
yarn start

Port Configuration

To change the default port (1122), modify the ports section in docker-compose.yml:

ports:
  - "YOUR_PORT:3000"  # Change YOUR_PORT to your preferred port

Data Storage Location

All your data is stored in the ./data directory:

• data/checklists/ - Your checklists
• data/notes/ - Your notes
• data/users/ - User data and sessions
• data/sharing/ - Sharing information
• data/settings.json - Application settings

Important: Always backup the data/ directory regularly!

Next Steps

• Initial Setup - Create your first admin account