Configurer une solution de tunnel (pour le développement local)

Ce guide vous accompagne dans la mise en place d'une solution de tunnel pour le développement local.

Pour tester en local, vous devez installer une solution de tunnel afin d'obtenir une URL externe.

Option 1 : utiliser localtunnel

Installer

npm install -g localtunnel

Démarrer

En supposant que le serveur supervaizer s'exécute sur le port 8000 (ce qui est le cas par défaut)

lt --port 8000
# votre URL est : https://silly-peaches-chapter.loca.lt

# ou, en option, définissez votre propre sous-domaine (s'il est disponible)

lt --port 8000 --subdomain my_supervaizer_agent
# votre URL est : https://my_supervaizer_agent.loca.lt

Conservez votre URL

Notez l'URL complète, par exemple https://my_supervaizer_agent.loca.lt. Stockez-la dans la variable d'environnement SUPERVAIZER_PUBLIC_URL.

Option 2 : utiliser ngrok

Installation

macOS

brew install ngrok

Windows

Installez-le depuis le Windows App Store

Linux (apt)

curl -sSL https://ngrok-agent.s3.amazonaws.com/ngrok.asc \
| sudo tee /etc/apt/trusted.gpg.d/ngrok.asc >/dev/null \
&& echo "deb https://ngrok-agent.s3.amazonaws.com bookworm main" \
| sudo tee /etc/apt/sources.list.d/ngrok.list \
&& sudo apt update \
&& sudo apt install ngrok

Configurer et déployer

Inscrivez-vous sur ngrok (gratuit avec des limitations) pour obtenir un jeton

Configurer

ngrok config add-authtoken <token>

Exécuter

ngrok http 8000

# Ou, en option, essayez de définir l'URL (offres payantes)
ngrok http 8000 --url my_supervaizer_agent.ngrok.dev

Ngrok en cours d'exécution

Update                        update available (version 3.26.0, Ctrl-U to update)
Version                       3.22.1
Region                        United States (us)
Web Interface                 http://127.0.0.1:4040
Forwarding                    https://e83bc6b8acec.ngrok-free.app -> http://localhost:8000

Conservez votre URL

Notez l'URL complète, par exemple https://my_supervaizer_agent.ngrok.dev. Stockez-la dans la variable d'environnement SUPERVAIZER_PUBLIC_URL.

Définir l'URL publique

Donnez l'URL au contrôleur avec une variable d'environnement ou avec une option de supervaizer start.

export SUPERVAIZER_PUBLIC_URL=https://my_supervaizer_agent.loca.lt
supervaizer start

# ou utilisez l'option
supervaizer start --public-url https://my_supervaizer_agent.loca.lt

L'option --public-url est prioritaire sur la variable d'environnement.

SUPERVAIZER_HOST

SUPERVAIZER_HOST est l'adresse sur laquelle le serveur écoute. N'y mettez pas le nom d'hôte du tunnel.

Et ensuite ?

Exportez votre variable d'environnement et démarrez le serveur