Skip to content

Héberger UnshortAPI

Jump to bottom
Johan le stickman edited this page May 6, 2023 · 2 revisions

Essayer sur Stackblitz

Open in Stackblitz

Héberger sur Vercel

Ce guide vous permet d'héberger UnshortAPI sur Vercel à l'aide de GitHub. Noter que les instructions pour créer un compte Vercel et GitHub ne sont pas incluses dans ce guide.

  1. Rendez-vous sur le GitHub d'UnshortAPI et cliquer sur le bouton vert "Use this template". Créer un repo

  2. Depuis ici, vous pouvez ajouter un nom et une description au repo que vous allez créer. Nous vous conseillons également de le rendre privé. Modifier les infos

  3. Patienter quelques instants pendant que votre repo se génère.

  4. Rendez-vous maintenant sur Vercel pour créer un nouveau projet à partir de votre repo Modifier les infos

  5. Ne modifier aucune option, apart le nom si vous souhaitez, ainsi que les variables d'environnements ("Environment Variables") pour personnaliser votre instance, puis cliquer sur "Deploy".

Votre propre instance devrait être déployée sur Vercel, vous pourrez vous rendre dans "Settings" puis "Domains" pour changer le domaine de votre API.

Héberger localement

Ce guide vous permet d'héberger UnshortAPI sur votre propre appareil. Ces instructions ont été faites pour Linux mais peuvent fonctionner sous Windows.

⚠️ L'adresse IP de l'hébergeur pourra être lue par les sites web dont vous tentez d'obtenir le lien original.

Pour cette méthode vous aurez besoin d'installer :

  • NPM et NodeJS v14 ou plus récent
  • Git CLI
  1. Dans un terminal, exécuter la commande git clone https://github.com/johan-perso/unshort-api.git pour télécharger tous les fichiers du serveur web.
  2. Rendez-vous dans le dossier avec cd unshort-api
  3. Installer les dépendances avec npm install
  4. Vous pouvez maintenant créer un fichier .env et y rajouter des variables d'environnements pour personnaliser l'instance
  5. Il ne vous reste qu'à configurer les redirections de port pour que le serveur web puisse être accessible par tout le monde.

Si vous souhaitez démarrer le serveur temporairement, vous n'avez qu'à utiliser la commande node index.js. Pour une utilisation en production, il est conseillé d'utiliser un outil tel que PM2 :

  1. Installer l'outil avec la commande npm install pm2 --global (les droits root peuvent être requis).
  2. Vous pourrez lancer le serveur avec pm2 start index.js, la commande pm2 stop index.js vous permettra de l'arrêter.

Noter que le serveur ne redémarre pas automatiquement quand votre appareil redémarre, vous pouvez suivre ces instructions pour le faire.

Critères d'un VPS

Si vous comptez utiliser un VPS pour héberger UnshortAPI, vous devez vous assurer que celui-ci vous autorise les choses suivantes :

  • Redirection de port pour le serveur web (de préférence 80, pour ne pas avoir à l'entrée manuellement dans l'URL).
  • Accès root (sudo) / administrateur.
  • Ne bloque pas l'accès à certains domaines.
  • Propose un accès internet sortant.
Clone this wiki locally