Comment créer votre propre Gist GitHub en utilisant Opengist

Opengist est un serveur Github Gist auto-hébergé pour Linux qui utilise Git pour charger, parcourir et réviser rapidement vos fichiers texte. Découvrez comment installer et héberger votre propre serveur Opengist sur Ubuntu.

Opengist est un serveur léger Github Gist auto-hébergé pour Linux. Contrairement à d'autres solutions, il utilise des fonctionnalités spécifiques de Git pour charger, parcourir et réviser rapidement vos fichiers texte. Voici comment installer et héberger votre propre serveur Opengist sur Ubuntu Linux.

Pourquoi héberger votre propre serveur Gist avec Opengist

L'un des principaux avantages d'Opengist est qu'il s'agit d'un service similaire à Pastebin qui utilise Git pour backend. Cela rend Opengist facile à prendre en main et à héberger sur Linux pour toute personne déjà familière avec les services Git avec prise en charge des Gists tels que Github et Gitlab.

Un autre point fort d'Opengist est sa capacité à suivre les collages spécifiques à l'utilisateur et à fournir des contrôles pour gérer la visibilité des collages. En conséquence, Opengist peut être une plateforme auto-hébergée pour partager du texte entre votre petit groupe de pairs.

Enfin, Opengist ne nécessite pas de ressources importantes. Sa configuration par défaut repose uniquement sur un seul conteneur Docker et un datastore, que vous pouvez soit définir en tant que volume interne, soit en tant que montage sur votre système de fichiers. Cela signifie que vous pouvez exécuter Opengist même sur des systèmes de faible puissance sans avoir beaucoup de ressources supplémentaires.

À noter : apprenez les bases de la gestion de code source en consultant notre guide complet pour débutants sur Git.

Préparation du système pour Opengist

Hypothèse : Ce tutoriel est réalisé sur un VPS Ubuntu 24.04 avec au moins 2 Go de RAM et 25 Go d'espace disque. On suppose également que vous possédez déjà un nom de domaine et que vous pouvez y ajouter un enregistrement DNS de type "A".

Remarque : Cette section se concentre sur l'installation de Docker sur les systèmes basés sur Ubuntu. Pour l'installer sur une distribution différente, consultez notre guide général sur l'installation de Docker sur Linux.

La première étape pour déployer Opengist sur votre machine consiste à obtenir et installer Docker, Nginx et Certbot. Pour cela, commencez par récupérer la clé de signature du projet Docker :

curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /etc/apt/keyrings/docker.gpg sudo chmod a+r /etc/apt/keyrings/docker.gpg

Créez un nouveau fichier de référentiel dans "/etc/apt/sources.list.d/":

sudo nano /etc/apt/sources.list.d/docker.list

Collez la ligne de code suivante dans votre nouveau fichier de référentiel:

deb [arch=amd64 signed-by=/etc/apt/keyrings/docker.gpg] https://download.docker.com/linux/ubuntu noble stable

Enregistrez votre fichier de référentiel, puis mettez à jour et mettez à niveau tous les packages existants de votre système :

sudo apt update && sudo apt upgrade

Récupérez le binaire Docker ainsi que son plugin Compose et ses dépendances :

sudo apt install docker-ce docker-ce-cli containerd.io docker-compose-plugin docker-buildx-plugin nginx

Assurez-vous que le package snap "core" est présent sur votre système :

sudo snap install core

Installez le package snap Certbot de la Electronic Frontier Foundation (EFF) :

sudo snap install certbot --classic

Installation et exécution d'Opengist

Créez un nouveau dossier pour Opengist dans le répertoire personnel de l'utilisateur actuel, puis allez-y :

mkdir -p ~/opengist/data && cd ~/opengist

Utilisez votre éditeur de texte préféré pour créer un nouveau fichier "docker-compose.yml" à l'intérieur de votre dossier Opengist :

nano ./docker-compose.yml

Collez le bloc de code suivant dans votre nouveau fichier compose :

services:
  opengist:
    image: ghcr.io/thomiceli/opengist:1.7
    container_name: opengist
    restart: unless-stopped
    ports:
      - "6157:6157"
      - "2222:2222"
    volumes:
      - ./data:/opengist"

Enregistrez votre fichier "docker-compose.yml", puis exécutez la commande suivante pour construire et installer Opengist sur votre système :

docker compose up -d

Confirmez que Opengist fonctionne en répertoriant tous les conteneurs Docker actifs sur votre machine :

docker ps

En aparté : découvrez comment déplacer vos conteneurs Docker vers un nouvel hôte.

Créer un proxy inverse SSL pour Opengist

À ce stade, vous disposez désormais d'une instance Opengist partiellement fonctionnelle qui s'exécute sur le port 6157. Pour l'utiliser de manière sécurisée sur Internet, vous devez le passer par un proxy inverse SSL à l'aide de Nginx.

Pour ce faire, créez un nouveau enregistrement DNS de type "A" sur votre nom de domaine pointant vers l'adresse IPv4 de votre machine Opengist.

Revenez à votre terminal de serveur, puis créez un nouveau fichier de configuration de site pour... (pas assez d'informations fournies, veuillez fournir plus de contexte)

Opengist:

sudo nano /etc/nginx/sites-available/opengist

Collez le bloc de code suivant à l'intérieur de votre nouveau fichier de configuration :

server {
    server_name SOUS-DOMAINE.VOTRE-DOMAINE-RACINE;
    location / {
        proxy_pass http://127.0.0.1:6157;
        proxy_http_version 1.1;
        proxy_redirect off;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";
        proxy_set_header X-Forwarded-Proto https;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header Host $host;
    }
}

Sauvegardez votre fichier de configuration du site, puis créez un lien symbolique de "/etc/nginx/sites-available/" vers "/etc/nginx/sites-enabled/" :

sudo ln -s /etc/nginx/sites-available/opengist /etc/nginx/sites-enabled/

Confirmez que votre configuration Nginx fonctionne correctement, puis démarrez le serveur web à l'aide de systemctl :

nginx -t
sudo systemctl enable --now nginx.service

Enregistrez votre système Opengist en utilisant votre adresse e-mail auprès de l'EFF :

sudo certbot register --agree-tos -m VOTRE@ADRESSE-EMAIL

Générez un nouveau certificat SSL pour votre nom de domaine en utilisant Certbot :

sudo certbot --nginx -d SOUS-DOMAINE.VOTRE-DOMAINE-RACINE

Confirmez que votre site web est accessible sur Internet en ouvrant un navigateur web et en accédant à votre nom de domaine.

Astuce : apprenez comment fonctionne le chiffrement sur Internet en générant vos propres certificats SSL avec OpenSSL.

Création de votre premier gist avec Opengist

Par défaut, Opengist ne fournit pas de compte administrateur pour votre instance personnelle. Pour en créer un, vous devez d'abord le régistrer via l'interface web de votre instance.

Commencez par accéder au sous-domaine de votre Opengist, puis cliquez sur le bouton S'inscrire dans le coin supérieur droit de la page.

Indiquez un nom d'utilisateur et un mot de passe pour votre compte administrateur, puis cliquez sur S'inscrire pour le créer.

Cela vous connectera automatiquement à l'interface Opengist et vous donnera une invite pour votre première page de gist. Saisissez ou collez un extrait de texte dans la zone de saisie, puis cliquez sur Créer un gist public pour générer votre premier gist.

Remarque : vous pouvez définir les paramètres de confidentialité de votre gist en cliquant sur la Flèche vers le bas à côté du bouton Créer un gist public.

Vous pouvez maintenant partager votre nouveau fichier gist avec n'importe qui en copiant son lien depuis la barre d'adresse de votre navigateur et en l'envoyant à votre destinataire.

Création et mise à jour d'un gist en utilisant SSH

Outre l'interface web, Opengist prend également en charge l'envoi et la modification de gists directement depuis le client Git CLI. Cela est utile si vous travaillez uniquement dans une session en ligne de commande et que vous n'avez pas accès à une interface graphique.

Créez un nouveau dossier pour votre page de gist dans le répertoire personnel de votre utilisateur :

mkdir ~/mon-gist && cd ~/mon-gist

Copiez ou créez un nouveau fichier texte contenant vos données de gist, puis initialisez un nouveau dépôt Git dans votre nouveau dossier :

cp ~/mon-fichier-texte.txt ~/mon-gist/
git init

Ajoutez les fichiers de votre dossier à votre nouveau dépôt Git, puis créez son premier commit :

git add .
git commit -m "Mon premier commit Opengist."

Définissez le point d'accès distant pour votre dépôt Git local vers votre serveur Opengist :

git remote add origin https://SOUS-DOMAINE.VOTRE-DOMAINE-RACINE/init

Envoyez votre nouveau dépôt vers votre serveur Opengist :

git push -u origin master

Fournissez vos informations d'identification Opengist, puis appuyez sur la touche Entrée pour confirmer la commande de push.

Copiez la commande Git que Opengist affiche dans votre session terminal, puis exécutez-la pour définir le nouvel origine distant pour votre dépôt.

Confirmez que vous avez correctement enregistré votre gist en regardant l'interface web de votre serveur.

Héberger votre propre serveur Opengist sur Linux et créer des pages de gist similaires à celles de Github ne sont que quelques-unes des choses que vous pouvez faire avec des logiciels auto-hébergeables. Explorez davantage l'auto-hébergement en examinant certaines des meilleures alternatives auto-hébergeables à Github aujourd'hui.

.

Questions et réponses importantes à connaître

Comment faire un GIST ?

Pour créer un Gist, suivez ces étapes : 1. Accédez à la page Gist de GitHub. 2. Dans le champ 'Contenu du fichier', tapez le texte de votre Gist. 3. Si vous souhaitez créer un Gist public, cliquez sur 'Créer un gist public'. Sinon, cliquez sur 'Créer un gist secret'. 4. Cliquez sur 'Créer un gist' pour finaliser la création du Gist. Note : Assurez-vous de fournir un titre clair et des descriptions précises pour améliorer la recherche et la visibilité de votre Gist.

Comment se créer un compte GitHub ?

Pour créer un compte GitHub, il suffit de se rendre sur https://github.com/ et de suivre les instructions fournies sur le site. Il est recommandé d'utiliser un mot de passe fort et unique pour sécuriser votre compte. Pour obtenir davantage d'informations sur la création d'un mot de passe solide, consultez la page « Création d'un mot de passe fort ».

Comment ouvrir GitHub ?

Pour ouvrir GitHub, suivez ces étapes rapides : 1. Sélectionnez le menu GitHub Desktop dans la barre de menus et cliquez sur 'Installer l'outil en ligne de commande'. 2. Ouvrez le terminal. 3. Tapez 'github' pour lancer GitHub Desktop sur le dernier dépôt ouvert. C'est tout ce qu'il faut pour ouvrir GitHub rapidement à partir de la ligne de commande.

Comment se connecter à son compte GitHub ?

Pour vous connecter à votre compte GitHub, vous avez deux options : HTTPS ou SSH. Vous pouvez utiliser GitHub CLI pour vous authentifier via HTTP ou SSH. Pour plus de détails, consultez gh auth login.

Maintenant que tu as fini de lire Comment créer votre propre Gist GitHub en utilisant Opengist, nous t'invitons à explorer davantage la catégorie Linux. Tu y trouveras d'autres articles intéressants qui élargiront tes connaissances et te tiendront informé. Ne cesse pas de lire et de découvrir plus!