简体中文 | English

A minimalist web notepad with API access, encryption support, and Markdown rendering.

• 📝 Instant Notes — Access any note by URL (/my-note)
• 🔌 API Access — JSON/text API for AI and programmatic access
• 🔒 Encryption — Per-note AES-256-CBC password protection
• 👁️ Read-Only Mode — Share notes that anyone can read, only password holders can edit
• 📖 Markdown — Toggle rendered Markdown preview
• 💾 Auto-Save — Content saved 1.5s after last keystroke
• ⌨️ Shortcuts — Ctrl+S save, Ctrl+M markdown, Tab indent
• 🌐 i18n — English and Simplified Chinese, switchable via UI
• 🎨 Zen-iOS Hybrid UI — Frosted glass, cold gray, tactile feedback
• 📦 Zero Dependencies — No database, no CDN, all assets localized

• PHP 7.4+ with OpenSSL extension
• Apache with mod_rewrite or Nginx
• Or Docker (recommended)

docker run -d --name easynote \
  -p 9933:80 \
  -v $(pwd)/data:/var/www/html/_notes \
  ghcr.io/wang4386/easynote:latest

Or use Docker Hub mirror:

docker run -d --name easynote \
  -p 9933:80 \
  -v $(pwd)/data:/var/www/html/_notes \
  qninq/easynote:latest

curl -O https://raw.githubusercontent.com/wang4386/easynote/main/docker-compose.yml
docker compose up -d

Default port: 9933. Notes are persisted in ./data/.

1. Clone or copy files to your web server directory
2. Ensure _notes/ directory is writable: chmod 755 _notes/
3. Enable mod_rewrite (Apache) or configure URL rewriting (Nginx)
4. Visit your site!

location / {
    try_files $uri $uri/ /index.php?note=$uri&$args;
}

location ~ ^/_notes/ {
    deny all;
}

# JSON response
curl https://your-site.com/api/my-note

# Plain text
curl https://your-site.com/api/my-note?raw=1

# Encrypted note
curl -H "X-Password: secret" https://your-site.com/api/my-note

JSON Response:

{
  "note": "my-note",
  "content": "Hello, World!",
  "exists": true,
  "encrypted": false,
  "length": 13,
  "modified": "2025-01-01T12:00:00+00:00"
}

# JSON body
curl -X POST -H "Content-Type: application/json" \
  -d '{"content":"Hello from API"}' \
  https://your-site.com/api/my-note

# With encryption
curl -X POST -H "Content-Type: application/json" \
  -d '{"content":"Secret note","password":"my-pass"}' \
  https://your-site.com/api/my-note

# Raw text body
curl -X POST -d "Hello from API" \
  https://your-site.com/api/my-note

Edit config.php:

• Set $default_lang in config.php to configure the default language
• Users can switch languages via the globe button (🌐) in the UI
• Language preference is saved in a cookie for 30 days
• You can also switch via URL parameter: ?lang=en or ?lang=zh

Click the lock icon (🔒) in the editor to choose a protection mode:

• Read-only password is stored as a bcrypt hash in _notes/{note}.meta
• Visitors see a yellow banner and a locked editor; click the banner to enter the password
• After unlocking, the owner can edit and optionally remove the protection

MIT