Rote

English | 中文

Demo ｜ Website ｜ iOS APP ｜ Explore ｜ Rabithua

Open API, more than one way to record 🤩, supports Self-Hosted, take control of your own data, come and go freely, no data hostage 🙅🏻

Preview

Core Features

• Stay Restrained: Everything for an elegant note-taking experience and restrained interaction
• Low Mental Burden: Less pressure and simpler, more intuitive recording experience, even deployment experience
• Open Interface: Open API interface, supports recording or getting data in any scenario
• Unbounded Freedom: Complete control over your data, free to export data
• Self-Hosted Deployment: One-click deployment using Docker or Dokploy
• Separated Architecture: Frontend and backend use separated architecture design, deploy only the services you need
• Markdown Articles: Standalone Article support, can be referenced by notes, offering a pure writing and reading experience
• iOS Client: More elegant App client

Quick Start

Method 1: Using Docker Hub Image

Copy docker-compose.yml to your server with Docker and Docker Compose installed

Note: If you use a reverse proxy, VITE_API_BASE should be your backend address after the reverse proxy

# Use latest version (default config file)
VITE_API_BASE=http://<your-ip-address>:18000 docker-compose up -d

# Use specific version
IMAGE_TAG=v1.0.0 docker-compose up -d

Method 2: Using Dokploy (Recommended)

Dokploy is an open-source Docker deployment platform that provides a visual interface for application deployment and management. If you have Dokploy installed, you can deploy Rote with one click using the template.

1. Access Dokploy: Open your Dokploy management interface
2. Select Template: Find and select the Rote template from the application template list
3. Deploy Application: Click the deploy button, Dokploy will automatically pull the images and start all services
4. Configure Domain (Optional): By default, the deployment uses Dokploy's auto-generated domain. If you need to configure a custom domain for your Rote, remember to set VITE_API_BASE in the environment variables to your domain address (e.g., http://your-domain.com or https://your-domain.com)

iOS App: Connect to Self-Hosted Backend

The iOS app can connect to your self-hosted backend.

1. On the login page, tap the welcome text at the top multiple times to open the config dialog.
2. Set API Base to your public backend URL (or reverse-proxy URL).
3. Continue with the normal login flow.

Detailed Instructions

For more deployment options and configuration instructions, please check the documentation in the doc/ directory:

• Self-Hosted Deployment Guide - Complete deployment and configuration guide
• API Documentation - API interface usage guide
• API Key Guide - How to use API Key

Video Tutorials (Bilibili)

• Local deployment tutorial
• Rote deployment via Dokploy

Community Projects

• Raycast Extension - Raycast extension for Rote, developed by @aBER0724
• Rerote - Data conversion tool that transforms data from other platforms (currently Memos) into Rote format
• Rotefeeder - Deno-based RSS/Atom feeder that periodically forwards feed items to Rote via OpenKey
• Rote Toolkit - A TypeScript-based enhancement toolkit for Rote, featuring a powerful CLI and a Model Context Protocol (MCP) server for AI integration
• Rote Skill - A reusable skill for AI agents to work with Rote through rote-toolkit

Technology Stack