Installer Karakeep avec Docker
Karakeep

Installer Karakeep avec Docker

Table des matières

GitHub - karakeep-app/karakeep: A self-hostable bookmark-everything app (links, notes and images) with AI-based automatic tagging and full text search
A self-hostable bookmark-everything app (links, notes and images) with AI-based automatic tagging and full text search - karakeep-app/karakeep

Aujourd'hui nous allons parler de Karakeep ! Pour ceux qui connaissent Hoarder, sachez que Karakeep est son digne successeur.

Cette application va vous permettre de "marquer" tout ce qui vous passe sous la main, de prendre des notes, stocker des images et bien d'autres choses, que je vous laisse découvrir plus bas.

Notez que le dev affiche cet avertissement sur son GitHub :

⚠️
Cette application est en cours de développement et est loin d'être stable.

Soyez donc prudent. C'est une application à suivre le développement, n'hésitez pas à remonter un bug ou faire une demande sur le GitHub du dev.

Je n'ai pas eu de bug gênant lors du test de Karakeep mais patientez que le dev la déclare comme stable avant de confier vos données.

⚡ Caractéristiques

  • 🔗 Mettez des liens en favoris, prenez des notes simples et stockez des images et des fichiers PDF.
  • ⬇️ Récupération automatique des titres, descriptions et images des liens.
  • 📋 Trier vos signets en listes.
  • 🔎 Recherche en texte intégral de tout le contenu stocké.
  • ✨ Tagging automatique basé sur l'IA (aka chatgpt). Avec des supports pour les modèles locaux utilisant ollama !
  • 🎆 OCR pour l'extraction de texte à partir d'images.
  • 🔖 Plugin Chrome et addon Firefox pour la mise en signet rapide.
  • 📱 Une application iOS et une application Android.
  • 📰 Accumulation automatique à partir de flux RSS.
  • 🔌 API REST.
  • 🌐 Prise en charge multilingue.
  • 🖍️ Marquer et stocker les points forts de votre contenu thésaurisé.
  • 🗄️ Archivage de pages entières (à l'aide de monolith) pour protéger le contenu contre le pourrissement des liens. Archivage automatique des vidéos à l'aide de youtube-dl.
  • ☑️ Prise en charge des actions en bloc.
  • 🔐 Support SSO.
  • 🌙 Support du mode sombre.
  • 💾 L'auto-hébergement d'abord.
  • [Prévue] Téléchargement du contenu pour une lecture hors ligne dans l'application mobile.

💾 Installation

Prérequis

Avant de commencer, assurez-vous d’avoir :

  • Distribution Linux (Ubuntu, Debian, etc ...).
  • Docker installé.
  • Accès terminal.
  • Connexion internet.
  • Générez deux clés que vous allez conserver précieusement pour la suite. Pour générer des clés, tapez cette commande deux fois dans votre terminal :
openssl rand -base64 36

Étapes d'Installation

  1. Créez votre compose.yml dans le dossier ou vous comptez installer Karakeep :
sudo nano compose.yml
  1. Et collez ça dedans :
services:
  web:
    image: ghcr.io/karakeep-app/karakeep:${KARAKEEP_VERSION:-release}
    restart: unless-stopped
    volumes:
      # By default, the data is stored in a docker volume called "data".
      # If you want to mount a custom directory, change the volume mapping to:
      # - /path/to/your/directory:/data
      - data:/data
    ports:
      - 3025:3000
    env_file:
      - .env
    environment:
      MEILI_ADDR: http://meilisearch:7700
      BROWSER_WEB_URL: http://chrome:9222
      # OPENAI_API_KEY: xxxx

      # You almost never want to change the value of the DATA_DIR variable.
      # If you want to mount a custom directory, change the volume mapping above instead.
      DATA_DIR: /data # DON'T CHANGE THIS
  chrome:
    image: gcr.io/zenika-hub/alpine-chrome:123
    restart: unless-stopped
    command:
      - --no-sandbox
      - --disable-gpu
      - --disable-dev-shm-usage
      - --remote-debugging-address=0.0.0.0
      - --remote-debugging-port=9222
      - --hide-scrollbars
  meilisearch:
    image: getmeili/meilisearch:v1.13.3
    restart: unless-stopped
    env_file:
      - .env
    environment:
      MEILI_NO_ANALYTICS: "true"
    volumes:
      - meilisearch:/meili_data

volumes:
  meilisearch:
  data:
  • # OPENAI_API_KEY: xxxx => Il faudra "décommenter" la ligne, c'est à dire supprimer le #, et ajouter une clé pour utiliser l'intelligence artificielle.
  1. Créez un fichier .env :
nano .env
  1. Collez ça dedans :
KARAKEEP_VERSION=release
NEXTAUTH_SECRET=c9aYJAbGsZNjCh0RvTzDUkQ12z7oBYYsVdvcOsHltbvmByQc
MEILI_MASTER_KEY=c9aYJAbGsZNjCh0RvTzDUkQ12z7oBYYsVdvcOsHltbvmByQc
NEXTAUTH_URL=http://192.168.1.152:3025
  • NEXTAUTH_SECRET=c9aYJAbGsZNjCh0RvTzDUkQ12z7oBYYsVdvcOsHltbvmByQc => Changez c9aYJAbGsZNjCh0RvTzDUkQ12z7oBYYsVdvcOsHltbvmByQc par votre propre clé.
  • MEILI_MASTER_KEY=c9aYJAbGsZNjCh0RvTzDUkQ12z7oBYYsVdvcOsHltbvmByQc => Changez c9aYJAbGsZNjCh0RvTzDUkQ12z7oBYYsVdvcOsHltbvmByQc par votre propre clé.
  • NEXTAUTH_URL=http://192.168.1.152:3025 => Remplacez 192.168.1.152 par l'IP de vôtre serveur.
💡
Vous avez d'autres variables d'environnement ici.
  1. On va déployer l'application :
docker compose up -d
  1. Rendez-vous sur l'ip:port, suivant l'IP de votre serveur local et du port choisi, 3025 par défaut :
http://ip:3025/

ou votre domaine :

https://karakeep.mondomaine.com

👤 Création du compte administrateur

La première chose à faire quand vous lancez l'application pour le première fois, c'est de créer votre compte administrateur. Cliquez sur Sign Up et entrez les informations demandées:

  • Name => Indiquez le pseudo/nom souhaité.
  • Email => Indiquez une adresse e-mail.
  • Password => Choisissez un mot de passe fort.
  • Confirm Password => Confirmez votre mot de passe.

Cliquez sur Sign Up pour terminer.

Vous voici sur votre tableau de bord :


🇫🇷 Mettre l'interface en français

Cliquez en haut à droite sur votre compte et choisissez l'option User Settings :

Dans Options, choisissez la langue de votre choix, dans mon cas, le français :

Cliquez sur Save pour terminer.

C'est bien en français :


🌐 Ajouter un site web

Rien de plus simple, ajoutez l'URL dans la tuile NOUVEL ÉLÉMENT et cliquez sur Save:

Le site a bien été ajouté :

Quand vous cliquez sur les deux flèches :

Vous pouvez scroller le site :

Vous pouvez également ajouter un Tags, entrez le tag souhaité et valider en appuyant avec la touche Enter/Entrée de votre clavier. Si vous avez envie d'ajouter une note, tapez votre note, pour enregistrer et quitter, cliquez n'importe où, hors de la zone de saisie, l'enregistrement sera automatique:


🗒️Créer une note

Tapez votre note dans NOUVEL ÉLÉMENT, quand c'est terminé, cliquez sur Enregistrer :

La note est bien présente :

Pour éditer une note, cliquez sur les ... et sélectionnez Modifier :


Ajouter une image

Pour sauver une image, glissez l'image vers la page web de Karakeep, elle est automatiquement sauvée:


📗 Ajouter une liste

De base vous avez trois listes, All ListsFavourties et Archive:

sdfsd

  • 1 => Nommez votre liste et choisissez l'icône.
  • 2 => Ajoutez éventuellement une description.
  • 3 => Configurez s'il s'agit d'une liste parent ou non.
  • 4 => Manuel ou par IA.
  • 5 => Cliquez sur Créer pour terminer.

zarev

->.<-
🐧 Passionné de self-hosting, je partage ce que je connais et me nourris des connaissances des bonnes âmes qui partagent avec moi. Soutenons l'utilisation des apps open source et leurs développeurs.

Vous pourriez aussi aimer