Initial vault setup
This commit is contained in:
@@ -0,0 +1,136 @@
|
||||
---
|
||||
title: HedgeDoc
|
||||
created: 2026-06-07
|
||||
updated: 2026-06-07
|
||||
type: app
|
||||
tags: [catalogue, note-taking, collaboration, markdown, hedgedoc, realtime, docker]
|
||||
confidence: high
|
||||
contested: false
|
||||
sources: [https://selfh.st/apps/?tag=Note-Taking, https://hedgedoc.org, https://docs.hedgedoc.org/setup/getting-started, https://github.com/hedgedoc/hedgedoc]
|
||||
---
|
||||
|
||||
# 🤝 HedgeDoc
|
||||
|
||||
> **L’éditeur Markdown collaboratif en temps réel** : partage par lien, révisions, permissions simples et usage immédiat dans le navigateur.
|
||||
|
||||
## 📋 Informations Générales
|
||||
|
||||
| Champ | Valeur |
|
||||
| :--- | :--- |
|
||||
| **Site web** | [hedgedoc.org](https://hedgedoc.org) |
|
||||
| **GitHub** | [hedgedoc/hedgedoc](https://github.com/hedgedoc/hedgedoc) |
|
||||
| **Licence** | AGPL-3.0 |
|
||||
| **Langage** | TypeScript |
|
||||
| **Étoiles GitHub** | 7.2k ⭐ |
|
||||
| **Dernière MAJ** | 2026-05-19 |
|
||||
| **Catégorie** | [[cat-note-taking|Note-Taking]] |
|
||||
|
||||
## 📝 Description
|
||||
|
||||
**HedgeDoc** est un éditeur **Markdown collaboratif en temps réel** auto-hébergeable, historiquement issu de la lignée **HackMD / CodiMD**. L’application se concentre sur un cas d’usage clair : **écrire à plusieurs dans le navigateur**, sans installer de client natif, avec un rendu Markdown vivant et un partage simple par URL.
|
||||
|
||||
Le produit n’est pas un PKM personnel complexe à la Obsidian ; il excelle plutôt comme **bloc-notes collaboratif**, support de réunions, prise de notes d’équipe, rédaction conjointe de procédures, documents temporaires ou présentations Markdown. Le site officiel met aussi en avant les **révisions**, le **mode présentation** et la prise en charge de **diagrammes**.
|
||||
|
||||
HedgeDoc convient surtout à :
|
||||
|
||||
- des **notes collaboratives** ;
|
||||
- des **comptes-rendus de réunion** ;
|
||||
- des **documents techniques partagés** ;
|
||||
- des ateliers, formations ou événements où plusieurs personnes éditent en direct.
|
||||
|
||||
Points notables :
|
||||
|
||||
- ✅ **Collaboration temps réel**
|
||||
- ✅ **Markdown** dans le navigateur
|
||||
- ✅ **Révisions** et historique
|
||||
- ✅ **Permissions** simples
|
||||
- ✅ **Mode présentation**
|
||||
- ✅ Ressources modestes, y compris sur petites machines
|
||||
|
||||
## 🚀 Installation
|
||||
|
||||
### Option recommandée : Docker Compose
|
||||
|
||||
Une installation classique repose sur un conteneur HedgeDoc et une base PostgreSQL :
|
||||
|
||||
```yaml
|
||||
services:
|
||||
database:
|
||||
image: postgres:16-alpine
|
||||
restart: unless-stopped
|
||||
environment:
|
||||
POSTGRES_DB: hedgedoc
|
||||
POSTGRES_USER: hedgedoc
|
||||
POSTGRES_PASSWORD: CHANGE_ME_DB_PASSWORD
|
||||
volumes:
|
||||
- ./postgres-data:/var/lib/postgresql/data
|
||||
|
||||
hedgedoc:
|
||||
image: quay.io/hedgedoc/hedgedoc:1.10.8
|
||||
restart: unless-stopped
|
||||
ports:
|
||||
- "3000:3000"
|
||||
environment:
|
||||
CMD_DB_URL: postgres://hedgedoc:CHANGE_ME_DB_PASSWORD@database:5432/hedgedoc
|
||||
CMD_DOMAIN: notes.example.com
|
||||
CMD_URL_ADDPORT: false
|
||||
CMD_PROTOCOL_USESSL: true
|
||||
depends_on:
|
||||
- database
|
||||
```
|
||||
|
||||
Puis :
|
||||
|
||||
```bash
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
### Point d’attention produit
|
||||
|
||||
Le projet rappelle que **HedgeDoc 1.x** est stable mais en **maintenance**, tandis que **HedgeDoc 2** est une réécriture en cours. Pour un homelab pragmatique, la branche 1.x reste la référence de déploiement aujourd’hui.
|
||||
|
||||
## ⚙️ Configuration Initiale
|
||||
|
||||
1. **Déployer la base de données** et HedgeDoc.
|
||||
2. **Configurer le domaine** et le **HTTPS** via reverse proxy.
|
||||
3. **Choisir le mode d’authentification** voulu : local, OAuth/OIDC, etc.
|
||||
4. **Vérifier les permissions** de notes par défaut avant ouverture à un groupe.
|
||||
5. **Tester la collaboration** en ouvrant une note depuis plusieurs navigateurs.
|
||||
6. **Décider de la politique de conservation** selon que les notes sont temporaires ou durables.
|
||||
|
||||
## 🔄 Alternatives
|
||||
|
||||
### Open Source
|
||||
- [[app-etherpad]] — Collaboration temps réel plus généraliste, moins centré Markdown
|
||||
- [[app-docs-collaboration]] — Suite collaborative plus large
|
||||
- [[app-outline]] — Base documentaire d’équipe plus structurée
|
||||
- [[app-xwiki]] — Wiki collaboratif beaucoup plus complet
|
||||
- **HackMD** — Ancêtre/solution proche, mais plus orientée service hébergé
|
||||
|
||||
### Propriétaires
|
||||
- **Notion**
|
||||
- **Confluence**
|
||||
- **Google Docs**
|
||||
- **HackMD Enterprise**
|
||||
|
||||
## 🔐 Sécurité
|
||||
|
||||
- ✅ Placez HedgeDoc derrière **HTTPS**
|
||||
- ✅ Utilisez une authentification **SSO/OIDC** si l’instance est ouverte à une équipe
|
||||
- ⚠️ Les notes peuvent être partagées par lien : vérifiez les **permissions par défaut**
|
||||
- ✅ Sauvegardez la base PostgreSQL et les paramètres applicatifs
|
||||
- ⚠️ Si l’instance est publique, surveillez l’abus et le spam
|
||||
|
||||
## 📚 Ressources
|
||||
|
||||
- [Site officiel](https://hedgedoc.org)
|
||||
- [Documentation](https://docs.hedgedoc.org/)
|
||||
- [Guide d’installation](https://docs.hedgedoc.org/setup/getting-started)
|
||||
- [GitHub hedgedoc/hedgedoc](https://github.com/hedgedoc/hedgedoc)
|
||||
|
||||
## Pages Liées
|
||||
|
||||
- [[cat-note-taking]] — Vue d’ensemble de la catégorie Note-Taking
|
||||
- [[app-etherpad]] — Autre éditeur collaboratif temps réel
|
||||
- [[app-outline]] — Alternative plus structurée pour équipes
|
||||
- [[app-xwiki]] — Alternative wiki complète
|
||||
Reference in New Issue
Block a user