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
• iOS Client: More elegant App client (available outside China)

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)

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

Technology Stack