Héberger soi-même

Télécharger le code source

Avec Git

git clone https://github.com/hoststend/stend-web.git

Sans Git

Depuis un navigateur, allez sur le dépôt GitHub de Stend et cliquez sur le bouton vert "Code" puis sur "Download ZIP".

Vous pourrez ensuite extraire les fichiers dans un dossier de votre choix. Ouvrez un terminal dedans.

Configurer le client

Ouvrez un terminal dans le dossier de Stend (naviguez avec cd stend-web) puis exécutez ces commandes :

mv .env.example .env
nano .env

Vous pouvez maintenant modifier les valeurs de votre fichier .env pour configurer certains éléments. Pas d'inquiétude, des commentaires seront inclus dans le fichier pour vous aider.

Installer et compiler le client

pnpm install
pnpm build

Démarrer Stend

Le client a été compilé et un dossier build contenant les fichiers finaux, prêts à être servis, a été créé. Vous pouvez maintenant : configurer un serveur web (comme Apache ou Nginx) pour servir ces fichiers sur un serveur, utiliser un hébergeur statique (comme Vercel ou GitHub Pages), ou démarrer le client temporairement sur votre PC avec npm run start.

Créez un service

Depuis votre dashboard, dans un projet, créez un nouveau service "Application" et donnez lui le nom que vous souhaitez.

Configurer le service

Définissez le provider sur Git :

• Repository URL: https://github.com/hoststend/stend-web.git
• Branch: main
• Build Path: /
• Watch Paths: (empty)

Définissez également "Build Type" sur "Dockerfile" et utiliser "Dockerfile" comme fichier source.

Configurer les réglages

Des réglages par défaut sont appliqués pour faciliter un déploiement rapide, vous pouvez cependant utiliser les réglages d'environnement pour définir vos propres modifications. La liste des variables est disponible ici.

Cependant, il est nécessaire de commencer en ajoutant les variables d'environnement suivantes :

FILE_MAX_SIZE="x GB"
API_BASE_URL="https://stend-api.example.com"
SHOW_HTML_EXTENSION="false"

Finalisation

• Lors de l'ajout d'un domaine, le port à utiliser est 80 si vous n'avez pas apporté de modifications à la variable d'environnement PORT.
• Pensez à faire un nouveau déploiement après avoir modifié les réglages liés à l'environnement ou aux domaines.
• Il est conseillé d'ajouter la variable d'environnement FILE_MAX_SIZE pour permettre d'afficher sur l'accueil la limite maximale d'envoi supportée par l'API.

Créez un dossier

mkdir stend-web
cd stend-web

Écrire le docker-compose.yml

Vous aurez maintenant besoin de créez un fichier docker-compose.yml dans le dossier actuel. Vous pouvez copier cet exemple de configuration en modifiant les variables d'environnement que vous pensez être importantes.

version: '3'

services:
	stend-web:
		image: makeinlab/stend-web:latest
		environment:
			# Texte affiché sur le site pour indiquer la taille maximale autorisée par fichier
			FILE_MAX_SIZE: 5 GB

			# URL de l'API, doit pouvoir être accédée par le client, une erreur sera affichée dans la console du navigateur dans le cas contraire
			# Une adresse IP locale (localhost, 127.0.0.1, ...) ne fonctionnera pas si l'utilisateur du site n'est pas sur le même réseau que le serveur
			API_BASE_URL: https://stend-demo-api.exemple.com

			# Port sur lequel le serveur web écoutera
			PORT: 80

			# Afficher ".html" dans le chemin des fichiers ?
			# Le serveur intégré dans cette image est capable de servir des fichiers HTML sans l'extension ".html" dans l'URL
			# Exemple - false : https://stend.example.com/d?frezazer (recommandé)
			# Exemple - true : https://stend.example.com/d.html?frezazer
			SHOW_HTML_EXTENSION: false
		ports:
			- 80:80
		volumes:
			- stend_web:/usr/src/app/build

volumes:
	stend_web:

Démarrer le conteneur à l'avant-plan

Cette étape permet de démarrer le client WEB de Stend dans votre terminal, sans détacher le processus, cela vous permettra de repérer immédiatement des potentielles erreurs, vaut mieux être prudent. Si vous êtes sûr que tout fonctionne, vous pouvez ignorer cette étape et passer à la suivante.

docker compose up

Démarrer le conteneur en arrière-plan

Une fois sûr que tout fonctionne, arrêter le service avec CTRL+C, et exécuter cette commande pour démarrer le client WEB en tâche de fond. Vous pourrez alors fermer votre terminal.

docker compose up -d

Dernière vérification

Assurez-vous que le client fonctionne en ouvrant un navigateur et en vous rendant sur http://<local ip>. Si le serveur tourne sur le même ordinateur, vous pouvez directement ouvrir http://localhost.

Si vous rencontrez un problème, ouvrez la console de votre navigateur (les réglages Développeur doivent être activés sur Safari) et tentez de lire les erreurs, ou demander de l'aide.