Héberger pgAdmin 4 pour votre base PostgreSQL

Introduction

Pour développer et héberger une instance pgAdmin sur Square Cloud, il est essentiel de suivre une séquence structurée de configurations et de prérequis. Ce guide technique couvrira l’ensemble du processus, de la configuration initiale au déploiement en production.

Prérequis

Compte Square Cloud : Inscrivez-vous via la page d’inscription en utilisant votre adresse e-mail.
Plan actif : Garantit des ressources dédiées et des performances optimisées pour votre application. Consultez nos plans disponibles et choisissez celui qui convient le mieux à vos besoins.

Ce guide utilise le runtime Python.

Obtenir le projet

pgAdmin s’exécute sur Python : le projet a donc besoin d’un requirements.txt ou d’un pyproject.toml (consultez comment créer un requirements.txt). Il liste pgadmin4 ainsi qu’un serveur web pour le servir. Ce guide utilise gunicorn :

requirements.txt

pgadmin4==9.18
gunicorn==26.2.0

Les versions sont figées, comme dans notre release prête à l’emploi, pour qu’une réinstallation ne passe jamais à une nouvelle version incompatible. Pour mettre à jour plus tard, modifiez-les ici et envoyez à nouveau votre projet. Ensuite, créez un fichier config_local.py. pgAdmin le lit au démarrage : ces paramètres l’exécutent comme serveur web et gardent ses données, son log et sa base SQLite dans un dossier .pgadmin à l’intérieur de votre application.

config_local.py

SERVER_MODE = True
MAX_LOGIN_ATTEMPTS = 3
"""
    CRITICAL 50
    ERROR    40
    WARNING  30
    SQL      25
    INFO     20
    DEBUG    10
    NOTSET    0
"""
CONSOLE_LOG_LEVEL = 10
DATA_DIR = "/application/.pgadmin/"
LOG_FILE = "/application/.pgadmin/logfile"
SQLITE_PATH = '/application/.pgadmin/pgadmin4.db'

Tout est déjà prêt pour le déploiement dans nos releases pgadmin4-web. Il vous suffit de télécharger le project.zip, de renseigner les deux variables ci-dessous et de l’envoyer.

Configurer Square Cloud

Créez un fichier squarecloud.app à la racine de votre projet :

squarecloud.app

DISPLAY_NAME=App name
RUNTIME=python
MEMORY=1024
START=python -m gunicorn --bind 0.0.0.0:80 --workers=1 --threads=4 pgadmin4.pgAdmin4:app
VERSION=recommended
SUBDOMAIN=my-pgadmin-subdomain

Gunicorn écoute sur le port 80 sur toutes les interfaces (0.0.0.0), là où Square Cloud achemine le trafic de votre sous-domaine. Gardez un seul worker (--workers=1) et ajoutez plutôt des threads : avec plus de workers, pgAdmin échoue avec des erreurs CSRF. Lors d’un envoi depuis le tableau de bord, définissez manuellement le runtime sur Python et utilisez la même commande START comme commande de démarrage.

Variables d’environnement

Définissez 2 variables d’environnement, PGADMIN_SETUP_EMAIL et PGADMIN_SETUP_PASSWORD. pgAdmin les utilise pour créer le premier utilisateur lors de son premier démarrage.

.env

PGADMIN_SETUP_EMAIL=accessemail@example.com
PGADMIN_SETUP_PASSWORD=yourSecurePassword

Définissez-les dans la Configuration avancée du formulaire d’envoi, sur la page Variables d’environnement de l’application (puis redémarrez-la), ou avec squarecloud app env set. pgAdmin ne lit pas de fichier .env à la racine de votre projet : ces valeurs ne fonctionnent donc que comme variables d’environnement. Consultez Variables d’environnement.

Contenu du ZIP

requirements.txt ou pyproject.toml
config_local.py
squarecloud.app

Déployer et vérifier

Via le tableau de bord

Accéder à la page d'upload

Accédez à la page d’upload et téléversez le fichier zip de votre projet.

Configurer votre environnement

Après avoir téléversé votre zip, vous devrez configurer le nom, le fichier principal ou l’environnement d’exécution ainsi que d’autres paramètres de votre projet.
Si vous téléversez un projet web, veillez à sélectionner « Publication Web » et à définir un sous-domaine pour votre projet.

Déployer votre projet

Enfin, cliquez sur le bouton « Deploy » pour héberger votre projet sur Square Cloud.
Une fois le déploiement effectué, vous pouvez suivre l’état et les logs de votre projet depuis le tableau de bord.

Téléversement d'une application vers Square Cloud

Confirmez que votre application est en ligne

Votre premier déploiement prend généralement moins d’une minute. Dans le tableau de bord, attendez que le statut de votre application affiche « en cours d’exécution » et vérifiez les logs pour détecter d’éventuelles erreurs de démarrage.
Si vous avez déployé un site web ou une API, ouvrez https://<votre-sous-domaine>.squareweb.app dans votre navigateur, vous devriez voir votre application répondre. Si vous avez déployé un bot, envoyez-lui une commande pour confirmer qu’il est en ligne.

Votre application ne démarre pas ? Consultez le guide de dépannage pour les causes les plus courantes et leurs solutions.

Via la CLI

Pour utiliser cette méthode, votre projet a besoin d’un fichier de configuration nommé squarecloud.app à sa racine. Il indique à Square Cloud comment exécuter votre application.

Guide du fichier de configuration

Apprenez comment créer le fichier de configuration squarecloud.app qui définit l’environnement de votre application.

Installer la CLI

Installez la CLI Square Cloud. Si vous l’avez déjà, exécutez la même commande pour la mettre à jour :

curl -fsSL https://cli.squarecloud.app/install | bash

npm install -g @squarecloud/cli@latest

Se connecter

Exécutez la commande ci-dessous. Elle ouvre votre navigateur : approuvez-y la connexion et la CLI est prête. Il n’y a aucune clé API à copier. Pour les scripts et la CI, consultez Authentification de la CLI.

squarecloud auth login

Téléverser votre projet

Depuis le dossier de votre projet, exécutez la commande ci-dessous. La CLI compresse le dossier courant en zip, sans ce que liste squarecloud.ignore, puis l’envoie :

squarecloud upload

Pour téléverser un zip que vous avez créé vous-même, passez-le avec --file :

squarecloud upload --file <path/to/zip>

Confirmez que votre application est en ligne

Votre premier déploiement prend généralement moins d’une minute. Vérifiez le statut et les logs de votre application directement depuis le terminal :

squarecloud app status
squarecloud app logs

Si vous avez déployé un site web ou une API, ouvrez https://<votre-sous-domaine>.squareweb.app dans votre navigateur, vous devriez voir votre application répondre. Si vous avez déployé un bot, envoyez-lui une commande pour confirmer qu’il est en ligne.

Votre application ne démarre pas ? Consultez le guide de dépannage pour les causes les plus courantes et leurs solutions.

Premier accès

Ouvrez https://my-pgadmin-subdomain.squareweb.app et connectez-vous avec l’e-mail et le mot de passe que vous avez définis. Ajoutez ensuite votre serveur PostgreSQL pour le gérer depuis n’importe où.

Erreurs courantes

Domaine personnalisé

Pour utiliser un domaine personnalisé (par exemple mysite.com) au lieu de l’URL par défaut mysite.squareweb.app, vous avez besoin du plan Standard ou supérieur. L’URL par défaut provient du champ SUBDOMAIN du fichier de configuration. Pour connecter votre domaine, suivez comment configurer votre propre domaine.

Prérequis minimum en RAM

Minimum : 512 Mo de RAM pour les sites web et les API, ce qui suffit pour un build statique sur le runtime statique. Pour les applications qui génèrent les pages sur un serveur (Next.js, Nuxt, Angular SSR et similaires), nous recommandons au moins 1 Go de RAM. Pour les applications plus volumineuses, allouez davantage de RAM afin d’éviter que l’application ne manque de mémoire et ne plante.

Impossible de trouver ce site.

Vérifiez que le sous-domaine/domaine correspond à ce qui est configuré dans le champ SUBDOMAIN ou dans les paramètres du domaine personnalisé. Si vous venez tout juste de mettre en ligne le site, patientez jusqu’à 60 secondes pour que Square active le premier accès.

Le site a mis trop de temps à répondre…

Votre serveur doit écouter sur le port 80 et l’hôte 0.0.0.0. Square Cloud définit les variables d’environnement PORT (80) et HOST (0.0.0.0) dans votre application : lisez-les dans votre code au lieu de coder en dur d’autres valeurs. Un serveur qui n’écoute que sur localhost ou 127.0.0.1 ne reçoit jamais de requêtes.

Erreurs CSRF après la connexion

pgAdmin tourne avec plus d’un worker Gunicorn. Définissez --workers=1 dans la commande START, ajoutez des threads avec --threads si vous avez besoin de plus de capacité, puis redémarrez l’application.

Prochaines étapes

Base de données gérée

Créez une base de données PostgreSQL à gérer avec pgAdmin.

Erreurs de connexion à la base de données

Corrigez les erreurs SSL/TLS et de connexion.

Gunicorn

Réglez le serveur web qui exécute pgAdmin.

Pour en savoir plus sur pgAdmin, consultez la documentation officielle de pgAdmin.

Contactez-nous

Si vous rencontrez toujours des difficultés techniques, notre équipe de support spécialisée est disponible pour vous aider. Contactez-nous et nous serons ravis de vous aider à résoudre tout problème. La qualité du support compte pour beaucoup dans la note que les développeurs donnent à Square Cloud, 4,9/5 sur 402 avis sur Google et Trustpilot.

Bots

Sites web

API et backends

Bases de données

Applications auto-hébergées

Guides

Guides de migration

Héberger pgAdmin 4 pour votre base PostgreSQL

Introduction

Prérequis

Obtenir le projet

Configurer Square Cloud

Variables d’environnement

Contenu du ZIP

Déployer et vérifier

Via le tableau de bord

Via la CLI

Guide du fichier de configuration

Premier accès

Erreurs courantes

Domaine personnalisé

Prérequis minimum en RAM

Impossible de trouver ce site.

Le site a mis trop de temps à répondre…

Erreurs CSRF après la connexion

Prochaines étapes

Base de données gérée

Erreurs de connexion à la base de données

Gunicorn

Contactez-nous

​Introduction

​Prérequis

​Obtenir le projet

​Configurer Square Cloud

​Variables d’environnement

​Contenu du ZIP

​Déployer et vérifier

​Via le tableau de bord

​Via la CLI

Guide du fichier de configuration

​Premier accès

​Erreurs courantes

​Domaine personnalisé

​Prérequis minimum en RAM

​Impossible de trouver ce site.

​Le site a mis trop de temps à répondre…

​Erreurs CSRF après la connexion

​Prochaines étapes

Base de données gérée

Erreurs de connexion à la base de données

Gunicorn

​Contactez-nous

Introduction

Prérequis

Obtenir le projet

Configurer Square Cloud

Variables d’environnement

Contenu du ZIP

Déployer et vérifier

Via le tableau de bord

Via la CLI

Premier accès

Erreurs courantes

Domaine personnalisé

Prérequis minimum en RAM

Impossible de trouver ce site.

Le site a mis trop de temps à répondre…

Erreurs CSRF après la connexion

Prochaines étapes

Contactez-nous