English | 简体中文
Sillage is a self-hosted, single-user space for private records, history review, and AI answers grounded in your own notes.
The first time an instance is opened, you create its only account. After that, authentication is required to access records, attachments, summaries, and Ask conversations.
- Write records in Markdown, upload images or files, and recover unsaved drafts.
- Revisit records through lists, a calendar, and search, then organize them with favorites and archives.
- Configure an Anthropic-compatible or OpenAI-compatible API endpoint to generate record summaries and source-grounded answers.
- Use the responsive Web interface or the native Android client in English or Simplified Chinese, with online and offline writing and manual record sync.
Sillage does not provide multi-user collaboration, public profiles, social sharing, background automatic sync, or an official hosted service. Public ingress, TLS, DNS, tunneling, CDNs, and other edge-network services are infrastructure operated separately by the deployer. They are outside the Sillage product and repository, which does not bundle third-party network connectors, credentials, or vendor-specific deployment configuration.
With Docker installed, run:
docker run --rm \
-p 127.0.0.1:5231:5231 \
-v "$HOME/.sillage:/var/opt/sillage" \
ghcr.io/getsillage/sillage:latestOpen http://localhost:5231 and create the instance's only account.
That is enough for a local install. Data lives in $HOME/.sillage. To upgrade, stop the container, back up that directory, pull again with the same command (or docker pull ghcr.io/getsillage/sillage:latest), and start it once more.
For Compose, reverse proxy, environment variables, public exposure, pinning a release image, or building from source, see the Deployment Guide and Data, Backup, and Recovery.
- Go and Echo monolithic backend
- SQLite database and local attachment storage
- React, TypeScript, and Vite Web client embedded in the Go binary
- Kotlin and Jetpack Compose Android client
- Protobuf API contract exposed through both REST v1 and Connect v1
See the Architecture Guide for detailed boundaries and sources of truth.
| Goal | Resource |
|---|---|
| Deploy an instance | Deployment Guide |
| Back up, restore, or migrate data | Data, Backup, and Recovery |
| Configure AI and understand external data handling | AI Usage and Privacy |
| Get setup or usage help | Support Guide |
| Contribute to the project | Contributing Guide |
| Understand system boundaries | Architecture Guide |
| Modify authentication, attachments, or secrets | Security Development Boundaries |
| Modify sync clients | Sync API |
| Modify the product or interface | Product Guidance / Web Design Guidelines |
| Build the Android client | Sillage Android Guide |
| Download releases and view changes | GitHub Releases |
See the Documentation Hub for the complete index. Report security issues privately according to the Security Policy.
The backend requires Go 1.26. Node.js 24 and pnpm 11.9 are recommended for the Web client; Android development requires JDK 17 and the Android SDK. Setup, local development, generated artifacts, and validation requirements are documented in the Contributing Guide.
Before submitting a change, read the Contributing Guide and Code of Conduct. Keep changes within Sillage's scope as a private, single-user record space, and include the relevant tests and documentation.
Sillage handles private records, attachments, login sessions, and encrypted AI API keys. Do not disclose vulnerabilities or real user data in public issues. Follow the private reporting process in the Security Policy.
Sillage is licensed under the MIT License.