mirror of https://github.com/lfnovo/open-notebook.git synced 2026-04-30 20:39:55 +00:00

LUIS NOVO fb6dd01111 docs: add pull_policy always to docker-compose examples

Add pull_policy: always to all open_notebook service definitions
in docker-compose examples across documentation. This ensures
Docker always checks for and pulls newer images when running
docker compose up.

Closes #393

2026-01-09 07:57:25 -03:00

3.3 KiB

Raw Blame History

Single Container Installation

All-in-one container setup. Simpler than Docker Compose, but less flexible.

Best for: PikaPods, Railway, shared hosting, minimal setups

Alternative Registry: Images available on both Docker Hub (lfnovo/open_notebook:v1-latest-single) and GitHub Container Registry (ghcr.io/lfnovo/open-notebook:v1-latest-single).

⚠️ Note: While this is a simple way to get started, we recommend Docker Compose for most users. Docker Compose is more flexible and will make it easier if we add more services to the setup in the future. This single-container option is best for platforms that specifically require it (PikaPods, Railway, etc.).

Prerequisites

Docker installed (for local testing)
API key from OpenAI, Anthropic, or another provider
5 minutes

Quick Setup

For Local Testing (Docker)

# docker-compose.yml
services:
  open_notebook:
    image: lfnovo/open_notebook:v1-latest-single
    pull_policy: always
    ports:
      - "8502:8502"  # Web UI (React frontend)
      - "5055:5055"  # API
    environment:
      - OPENAI_API_KEY=sk-...
      - SURREAL_URL=ws://localhost:8000/rpc
      - SURREAL_USER=root
      - SURREAL_PASSWORD=password
      - SURREAL_NAMESPACE=open_notebook
      - SURREAL_DATABASE=open_notebook
    volumes:
      - ./data:/app/data
    restart: always

Run:

docker compose up -d

Access: http://localhost:8502

For Cloud Platforms

PikaPods:

Click "New App"
Search "Open Notebook"
Set environment variables
Click "Deploy"

Railway:

Create new project
Add lfnovo/open_notebook:v1-latest-single
Set environment variables
Deploy

Render:

Create new Web Service
Use Docker image: lfnovo/open_notebook:v1-latest-single
Set environment variables in dashboard
Configure persistent disk for /app/data and /mydata

DigitalOcean App Platform:

Create new app from Docker Hub
Use image: lfnovo/open_notebook:v1-latest-single
Set port to 8502
Add environment variables
Configure persistent storage

Heroku:

# Using heroku.yml
heroku container:push web
heroku container:release web
heroku config:set OPENAI_API_KEY=sk-...

Coolify:

Add new service → Docker Image
Image: lfnovo/open_notebook:v1-latest-single
Port: 8502
Add environment variables
Enable persistent volumes
Coolify handles HTTPS automatically

Environment Variables

Variable	Purpose	Example
`OPENAI_API_KEY`	API key	`sk-...`
`SURREAL_URL`	Database	`ws://localhost:8000/rpc`
`SURREAL_USER`	DB user	`root`
`SURREAL_PASSWORD`	DB password	`password`
`API_URL`	External URL (for remote access)	`https://myapp.example.com`

Limitations vs Docker Compose

Feature	Single Container	Docker Compose
Setup time	2 minutes	5 minutes
Complexity	Minimal	Moderate
Services	All bundled	Separated
Scalability	Limited	Excellent
Memory usage	~800MB	~1.2GB

Next Steps

Same as Docker Compose setup - just access via http://localhost:8502 (local) or your platform's URL (cloud).

See Docker Compose for full post-install guide.

3.3 KiB Raw Blame History