π The open-source, offline-first Notion, Obsidian & Confluence alternative. Advanced Markdown, multi-tenant teams, OIDC/SSO, and local S3 backups. Deploy in one command.
Vue dockergolangkanbanknowledge-baseknowledge-managementmarkdownnote-takingnotesnotes-appnotionnuxtnuxtjsoffline-firstoidcpwaselfhostedssovuevuejswiki
Add infos about object storage
Smaug6739a6320be5ab6f
diff --git a/README.md b/README.mdindex 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-## Quick Start with DockerFor 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 --builddocker 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