Skip to content

πŸ“š The open-source, offline-first Notion, Obsidian & Confluence alternative. Advanced Markdown, multi-tenant teams, OIDC/SSO, and local S3 backups. Deploy in one command.

Add infos about object storage

Smaug6739a6320be5ab6f
diff --git a/README.md b/README.md
index 3eda50dd..2715e049 100644
--- a/README.md
+++ b/README.md
@@ -21,11 +21,12 @@ Organize, search, and export your notes with an intuitive interface designed for
## ✨ Features
-**Enhanced Markdown Editor** – Write notes with advanced syntax.
+**Enhanced Markdown Editor** – Write notes with advanced and unique Markdown features.
**Instant Search** – Find your notes in seconds.
**Intuitive Organization** – Easily categorize and archive your notes.
**Export & Print** – Save your notes as PDF, Markdown, and more.
**Access Anywhere** – Log in and retrieve your notes from any device.
+**Share Notes** – Share your notes with others via unique links or powerful permissions system.
---
@@ -37,7 +38,6 @@ Organize, search, and export your notes with an intuitive interface designed for
![Interface 3](./frontend/public/screenshots/mock/3.png)
-
## Quick Start with Docker
For local testing and development, you can use Docker to run the entire stack:
@@ -58,7 +58,7 @@ docker compose -f docker-compose.yml -f docker-compose.dev.yml up --build
- 🌐 **Frontend**: http://localhost:8200
- πŸ”Œ **Backend API**: http://localhost:8201
-- πŸ“¦ **MinIO Console**: http://localhost:9001
+- πŸ“¦ **Object Storage Console**: http://localhost:9001
- πŸ—„οΈ **MySQL**: localhost:3307 (user: `alexandrie`, password: `password`)
**To stop:**
@@ -67,6 +67,8 @@ docker compose -f docker-compose.yml -f docker-compose.dev.yml up --build
docker compose down
```
+_The project support S3 compatible storage. The default in docker-compose is RustFS but you can use MinIO, garage, etc._
+
If you don't have Docker installed, you can follow the manual setup instructions in the [CONTRIBUTING.md](./CONTRIBUTING.md).
## Contributing