selfhost.directory

The index of self-hostable projects — ranked, categorized and served with live updates.
Own your data and stop giving it to big tech.

GitHub
Ars-note logo

Self-host Ars-note

v1.5.98

Local-first Markdown workspace with AI game design assistant

BetaOpen SourceGPL-3.0
Updatedlast month
LanguageTypescript
Setup difficultyModerate
Stars
292
Port
8787 (sync server HTTP/WebSocket)
Requires
Node.js
Install with Docker Compose
Ars-note document workspace with file navigation, live preview, and project document radarArs-note bidirectional mind map with outline viewArs-note AI game design review assistant

What is Ars-note?

Ars-note is a local-first Markdown workspace designed for game development teams. It provides a desktop Electron application for Windows with Markdown editing, live preview, tables, and canvas. Core capabilities include a bidirectional mind map with outline, an AI planning assistant that reviews game design documents using team context, team schedules with task documents and work-hour tracking, and multi-device real-time file sync with version history and server snapshots. The self-hosted sync server runs on Node.js 22 or Docker and can be deployed on a NAS using docker-compose.nas.yml or publicly behind an HTTPS reverse proxy with docker-compose.public.yml. Data stays on the user's machine unless sync or AI features are enabled. The project is licensed under GPL-3.0-only and is currently in public beta (v1.6.0-beta.1).

Should you self-host Ars-note?

Ars-note scores 44/100 on selfhost.directory (how scoring works) and ranks #56 of 81 in Notes & Editors. It has 292 GitHub stars.

It shipped 5 stable releases in the past year. The latest, v1.5.98, came out on 28 August 2026. New versions land roughly every 2 weeks.

Setup is moderate: expect some configuration beyond a single command. It is GPL-3.0-licensed and written mostly in Typescript.

Its closest alternative on selfhost.directory is Memos (86/100, 64 136 stars). It scores higher overall, so compare the two before you pick. See Ars-note vs Memos side by side.

Features

  • AI game design assistant
  • Bidirectional mind map
  • Encrypted credential storage
  • Health check endpoint
  • Local-first Privacy
  • Markdown editing with live preview
  • Real-time multi-device sync
  • Self-hosted sync server
  • Team schedule and task management
  • WebSocket live sync

Ars-note README

How to install Ars-note

Install Ars-note with Docker Compose

Docker, valid TLS certificate, domain/DDNS, reverse proxy
Environment variables
ARS_NOTE_SERVER_API_KEY (required, 32+ chars), ARS_NOTE_REQUIRE_API_KEY, ARS_NOTE_SECURITY_MODE, ARS_NOTE_ALLOWED_ORIGINS, ARS_NOTE_STORAGE_BACKEND, ARSNOTE_PORT, S3/MinIO settings
Copy-Item .env.example .env
# 在 .env 中设置至少 32 个随机字符的 ARS_NOTE_SERVER_API_KEY
docker compose -f docker-compose.nas.yml up -d

For NAS/local network deployment; data persisted in ./sync-data

How to configure Ars-note

  • ARS_NOTE_ALLOWED_ORIGINSPublic mode only trusts these browser origins. "null" is required by the packaged Electron client. Add a comma-separated HTTPS admin origin if needed

    Public mode only trusts these browser origins. "null" is required by the packaged Electron client. Add a comma-separated HTTPS admin origin if needed

    values: null or comma-separated HTTPS origins

  • ARSNOTE_PORT8787Sync server port (host mapping)

    Sync server port (host mapping)

    values: port number

  • ARS_NOTE_REQUIRE_API_KEYtruePublic/self-hosted deployments should fail closed when the key is missing

    Public/self-hosted deployments should fail closed when the key is missing

    values: true/false

  • ARS_NOTE_S3_ACCESS_KEY_IDMinIO access credentials (must match MINIO_ROOT_USER / MINIO_ROOT_PASSWORD)

    MinIO access credentials (must match MINIO_ROOT_USER / MINIO_ROOT_PASSWORD)

    values: access key

  • ARS_NOTE_S3_BUCKETars-note-syncS3 bucket name

    S3 bucket name

    values: bucket name

  • ARS_NOTE_S3_ENDPOINThttp://minio:9000Server connects to MinIO internally via Docker network

    Server connects to MinIO internally via Docker network

    values: S3 endpoint URL

  • ARS_NOTE_S3_FORCE_PATH_STYLEtruePath-style URLs (required for MinIO)

    Path-style URLs (required for MinIO)

    values: true/false

  • ARS_NOTE_S3_REGIONus-east-1S3 region

    S3 region

    values: AWS region

  • ARS_NOTE_S3_SECRET_ACCESS_KEYMinIO secret access key

    MinIO secret access key

    values: secret key

  • ARS_NOTE_SECURITY_MODElanLAN is the default. For an Internet-facing HTTPS reverse proxy, use docker-compose.public.yml, which switches this to "public" and fails closed

    LAN is the default. For an Internet-facing HTTPS reverse proxy, use docker-compose.public.yml, which switches this to "public" and fails closed

    values: lan/public

  • ARS_NOTE_SERVER_API_KEYAPI key for client authentication (required; use at least 32 random characters)

    API key for client authentication (required; use at least 32 random characters)

    values: 32+ random characters

  • ARS_NOTE_STORAGE_BACKENDlocalStorage backend: "local" or "s3" (local is the simplest NAS setup)

    Storage backend: "local" or "s3" (local is the simplest NAS setup)

    values: local/s3

  • MINIO_API_PORT9000MinIO port mappings (only change if you have port conflicts)

    MinIO port mappings (only change if you have port conflicts)

    values: port number

  • MINIO_CONSOLE_PORT9001MinIO console port

    MinIO console port

    values: port number

  • MINIO_ROOT_PASSWORDMinIO root password

    MinIO root password

    values: password

  • MINIO_ROOT_USERMinIO root credentials (set strong values for production)

    MinIO root credentials (set strong values for production)

    values: username

Ars-note releases & version history

More in Task Management

Rate this project

Click to rate — no account needed.

0 comments

Posting as guest
Loading comments…