Skip to content

Latest commit

 

History

History
203 lines (137 loc) · 6.05 KB

README.md

File metadata and controls

203 lines (137 loc) · 6.05 KB

Canvas Server

Server runtime for the Canvas project

! Refactor in progress

! Use the dev branch for now

On every iteration(refactor) of this project, I actually loose(as in - BREAK -) functionality!
We already had tab management implemented(great showcase for the bitmap-based context tree index), with named sessions and working browser extensions. I decided to slightly refactor the context? or workspace manager? Don't even remember(git history would show) - 6 months later we still have no working runtime and using AI actually makes things worse!
(as we are now in an attention-based economy(creds for coining the term for me to @TechLead, I'll rant about it in some "coding-canvas" live stream session @idnc.streams soon))

Sooo

New approach: "Do The Simplest Thing That Could Possibly Work(tm)"
Sorry Universe for the delay..

Installation

Run canvas-server locally

$ git clone https://github.com./canvas-ai/canvas-server /path/to/canvas-server
$ cd /path/to/canvas-server
$ npm install # or yarn install
$ npm run start # or yarn start

Docker

$ git clone https://github.com./canvas-ai/canvas-server /path/to/canvas-server
$ cd /path/to/canvas-server
$ CANVAS_SERVER_HOME=~/.canvas docker-compose up --build
# or, to ensure you are running the latest and greatest
# $ docker-compose build --no-cache
# $ docker-compose up --force-recreate
# Cleanup
$ docker-compose down --rmi all

Supported ENV vars with their defaults:

# Runtime variables (user | standalone)
CANVAS_SERVER_MODE: ${CANVAS_SERVER_MODE:-"standalone"} 

# Canvas server dirs
CANVAS_SERVER_HOME: ${CANVAS_SERVER_HOME:-/opt/canvas-server/server}
CANVAS_SERVER_CONFIG: ${CANVAS_SERVER_CONFIG:-/opt/canvas-server/server/config}
CANVAS_SERVER_DATA: ${CANVAS_SERVER_DATA:-/opt/canvas-server/data}
CANVAS_SERVER_CACHE: ${CANVAS_SERVER_CACHE:-/opt/canvas-server/server/cache}
CANVAS_SERVER_DB: ${CANVAS_SERVER_DB:-/opt/canvas-server/server/db}
CANVAS_SERVER_VAR: ${CANVAS_SERVER_VAR:-/opt/canvas-server/server/var}
CANVAS_SERVER_ROLES: ${CANVAS_SERVER_ROLES:-/opt/canvas-server/server/roles}
CANVAS_SERVER_HOMES: ${CANVAS_SERVER_HOMES:-/opt/canvas-server/users}

# Canvas USER dirs for single-user mode
# See env.js for more info

Configuration

  • Rename example-*.json to *.json and amend as needed
  • Configuration files can be split into multiple files adhering to the original JSON structure
    • config/data.json maybe be split into config/data.backends.json, config/data.sources.json etc

Initial Admin User Creation

When the Canvas server starts for the first time, it can automatically create an initial admin user if no users exist in the database. This is controlled by environment variables:

  1. Set CANVAS_ADMIN_EMAIL to the desired admin email (defaults to '[email protected]')
  2. Set CANVAS_ADMIN_PASSWORD to the desired admin password (required if admin creation is enabled)

Example:

# In .env file or environment variables
[email protected]
CANVAS_ADMIN_PASSWORD=securepassword
CANVAS_ADMIN_RESET=false # Reset admin pass

Update Canvas Server

$ cd /path/to/canvas-server
# Stop the canvas server
$ npm run stop # or npm run pm2:stop
$ rm -rf ./node_modules # Ensure we have a clean slate
# Fetch the latest version of canvas-server from Github
$ git pull origin main # or dev if you are feeling adventurous
$ npm install
$ npm start # or npm run pm2:start

Scripts

build-portable-image.sh

This script builds a Docker image for the Canvas Server with a portable configuration.

Usage

$ ./scripts/build-portable-image.sh [-n image_name] [-t image_tag] [-f dockerfile] [-c config_dir]

Options

  • -n: Image name (default: canvas-server)
  • -t: Image tag (default: portable)
  • -f: Dockerfile to use (default: Dockerfile)
  • -c: Config directory to copy (default: ./config)

install-docker.sh

This script installs Docker and Docker Compose on an Ubuntu system. It checks if Docker and Docker Compose are already installed, and if not, installs them.

Usage

$ ./scripts/install-docker.sh

install-ubuntu.sh

This script installs and sets up the Canvas Server on an Ubuntu system. It installs Node.js, clones the Canvas Server repository, and sets up the service.

Usage

$ ./scripts/install-ubuntu.sh [-r canvas_root] [-u canvas_user] [-g canvas_group] [-b canvas_repo_branch] [-n nodejs_version] [-e web_admin_email] [-f web_fqdn]

Options

  • -r: Canvas root directory (default: /opt/canvas-server)
  • -u: Canvas user (default: canvas)
  • -g: Canvas group (default: www-data)
  • -b: Canvas repository branch (default: dev)
  • -n: Node.js version (default: 20)
  • -e: Web admin email (default: $(hostname)@cnvs.ai)
  • -f: Web FQDN (default: my.cnvs.ai)

update-docker.sh

This script updates Docker containers for the Canvas Server.

Usage

$ ./scripts/update-docker.sh [-r canvas_root] [-f docker_compose_file] [-b target_branch] [-l log_file]

Options

  • -r: Canvas root directory (default: /opt/canvas-server)
  • -f: Docker Compose file (default: docker-compose.yml)
  • -b: Target branch for git pull (default: main)
  • -l: Log file (default: /var/log/canvas-docker-update.log)

update-git.sh

This script updates the Canvas Server by pulling the latest changes from the git repository and restarting the service.

Usage

$ ./scripts/update-git.sh

Authentication

Canvas Server supports two types of authentication:

  1. JWT Token Authentication: Used for web UI login and normal user sessions, see
  2. API Token Authentication: Used for programmatic access (CLI, Electron, browser extensions, curl-based scripts)

References

DB / Index

Storage

Roles

LLM Integration

Service discovery