Files
2026-07-13 12:10:23 +08:00

80 lines
2.6 KiB
YAML

name: Open Notebook
description:
Open Notebook is an open-source, self-hosted notebook and research workspace
for collecting sources, taking notes, searching, chatting with content, and
generating podcasts.
instructions:
Deploy the template, open the generated EasyPanel domain, and log in with the
configured Open Notebook password. Configure AI providers from Settings > API
Keys after the first login. If the password field is left blank, a random
password is generated and stored as OPEN_NOTEBOOK_PASSWORD in the app service
environment.
changeLog:
- date: 2026-06-19
description: First release
links:
- label: Website
url: https://www.open-notebook.ai
- label: Documentation
url: https://github.com/lfnovo/open-notebook/tree/main/docs
- label: Github
url: https://github.com/lfnovo/open-notebook
contributors:
- name: nyxst4ck
url: https://github.com/nyxst4ck
schema:
type: object
required:
- appServiceName
- appServiceImage
- databaseServiceName
- databaseServiceImage
properties:
appServiceName:
type: string
title: App Service Name
default: open-notebook
appServiceImage:
type: string
title: App Service Image
default: lfnovo/open_notebook:1.10.0
databaseServiceName:
type: string
title: Database Service Name
default: surrealdb
databaseServiceImage:
type: string
title: Database Service Image
default: surrealdb/surrealdb:v2
appPassword:
type: string
title: Open Notebook Password
default: ""
benefits:
- title: One-click deployment
description:
Creates the Open Notebook app and SurrealDB database services with the
required environment variables and persistent volumes.
- title: Secure defaults
description:
Generates database and encryption secrets during template creation and
supports a user-provided or generated application password.
- title: Reverse-proxy friendly
description:
Exposes only the frontend port and uses Open Notebook's built-in Next.js
API proxy for backend requests.
features:
- title: Source collection
description: Save documents, web pages, audio, video, and other research sources.
- title: Notebook workspace
description: Organize sources and notes into reusable research notebooks.
- title: AI chat and search
description: Ask questions across notebook context with citations.
- title: Podcast generation
description: Generate podcast-style audio from selected notebook content.
tags:
- AI
- Knowledge Management
- Notes
- Research