Installer Note Mark avec Docker

GitHub - enchant97/note-mark: Note Mark is a lighting fast and minimal; web-based Markdown notes app.

Note Mark is a lighting fast and minimal; web-based Markdown notes app. - enchant97/note-mark

GitHubenchant97

Aujourd'hui nous allons parler de Note Mark ! Une application de prise (et partage éventuel) de notes en Markdown.

Facile d'utilisation et peu gourmand en ressource (12 MB en moyenne), il vous accompagne également sur mobile, pour lequel il est adapté.

Son interface, sobre et bien pensée, minimise les distractions inutiles et vous permet de vous concentrer sur vos notes.

⚡ Caractéristiques

• Markdown (Markdown inspiré de GitHub, voir les spécifications ici).
• Nettoyage HTML, minimisation des attaques XSS.
• Adapté aux appareils mobiles.
• URL optimisées pour des liens plus clairs.
• Thème sombre et clair.
• Partage de bloc-notes.
• Système de stockage personnalisé basé sur des fichiers plats.
• Vues multiples pour une note (rendu, brut).
• Éditeur ultra-rapide avec raccourcis.
• Téléchargement et intégration de ressources.
• Prise en charge d'OIDC pour l'authentification unique.

💾 Installation

Prérequis

Avant de commencer, assurez-vous d’avoir :

• Distribution Linux (Ubuntu, Debian, etc ...).
• Docker installé.
• Accès terminal.
• Connexion internet.

Étapes d'installation

1. Commencez par créer un token en vous rendant sur ce site :

JWT Secret Free Key Generator | Secure JWT Tokens

Generate secure JWT secret keys with our free online tool. Create strong, random keys for your JWT tokens with customizable length and security options.

JWT Secret Generator

Configurez-le comme ceci :

• 1 => Réglez-le sur 64 bits.
• 2 => Cliquez sur Generate.
• 3 => Copiez votre token, gardez-le au chaud.

2. Créez votre compose.yml dans le dossier ou vous comptez installer Note Mark :

nano compose.yml

3. Et collez ça dedans :

services:
  note-mark:
    image: ghcr.io/enchant97/note-mark-aio:0.17.1
    restart: unless-stopped
    volumes:
      - ./data:/data
    environment:
      JWT_SECRET: "Votre_token"
      CORS_ORIGINS: "http://exemple.com"
    ports:
      - 8077:8080

• JWT_SECRET: "Votre_token" => Collez votre token entre les guillemets.
• CORS_ORIGINS: "http://exemple.com" => Indiquez l'URL de votre instance entre les guillemets. Si vous n'avez pas d'URL, laissez comme ça.

4. On va déployer l'application :

docker compose up -d

5. Rendez-vous sur l'ip:port, suivant l'IP de votre serveur local et du port choisi, 8077 par défaut :

http://ip:8077/

ou votre domaine :

https://notemark.mondomaine.com

👤 Création du compte administrateur

Lorsque vous lancez pour la première fois votre instance Note Mark, il faudra créer votre compte administrateur.

• 1 => Cliquez sur Login.

Vous arrivez ici :

• 1 => Cliquez sur Need An Account.

Complétez les informations demandées :

• 1 => Choisissez un nom d'utilisateur pour votre compte admin. Celui qui vous servira de login.
• 2 => Indiquez votre nom complet ou votre pseudo.
• 3 => Choisissez un mot de passe fort.
• 4 => Confirmez votre mot de passe.
• 5 => Cliquez sur Create User.

Vous pouvez maintenant vous connecter avec le compte créé :

• 1 => Indiquez votre nom d'utilisateur.
• 2 => Indiquez votre pseudo.
• 3 => Cliquez sur Login pour terminer.

Vous voilà sur votre tableau de bord :

📖 Créer un livre

Pour commencer, il va falloir créer un "livre" :

Complétez cette fenêtre :

• 1 => Nommez votre livre.
• 2 => Décidez ou non si ce livre doit-être public.
• 3 => Terminez en cliquant sur + Create.

Vous pouvez à présent créer une note.

Pour supprimer un livre :

• 1 => Cliquez sur le livre.
• 2 => Cliquez sur les trois petits points.
• 3 => Cliquez sur Notebook Settings.

Supprimez ou modifiez votre livre :

🗒️ Créer une note

Maintenant que vous avez votre livre, créez vos notes :

• 1 => Cliquez sur cette icône.

Cette petite fenêtre va apparaître :

• 1 => Nommez votre note.
• 2 => Cliquez sur + Create pour terminer.

Rédigez votre notre :

• 1 => Cliquez sur le crayon pour activer le mode édition.
• 2 => Faites votre note.

Vous pouvez également activer cette option pour avoir le rendu directement :

Supprimez ou modifiez votre note :

• 1 => Cliquez sur votre note.
• 2 => Cliquez sur Note Settings.

Supprimez ou modifiez votre note :

Vous pouvez également télécharger ou imprimer votre note :