Avant de commencer
- Elixir sur votre machine. Si ce n’est pas le cas, suivez le guide d’installation officiel d’Elixir.
- Un compte Square Cloud : inscrivez-vous avec votre e-mail ou GitHub.
- Un plan actif. Consultez les plans et choisissez celui qui convient à votre projet.
Configurer Square Cloud
Si vous envoyez votre application depuis le tableau de bord, vous pouvez passer cette section : le tableau de bord crée le fichier de configuration
squarecloud.app pour vous.Référence du fichier de configuration
Le fichier
squarecloud.app indique à Square Cloud comment exécuter votre application : son fichier principal, sa mémoire, la version du runtime, son nom et, pour un site web, son sous-domaine.- Bot ou worker
- Site web ou API
squarecloud.app
Ce que Square Cloud exécute
-
Si le champ
STARTn’est pas défini dans le fichier de configuration, Square Cloud exécuteramix run --no-haltpour démarrer le projet. Si le champSTARTest défini, la valeur qu’il contient sera exécutée directement. Pour plus d’informations sur les paramètres du fichier de configuration, consultez les paramètres de configuration. -
Avant
START, Square Cloud installe localement les outilshexetrebaret récupère les dépendances du projet avecmix deps.get. Si l’une de ces étapes échoue, l’application ne démarre pas. -
MAINindique seulement à Square Cloud que le projet est écrit en Elixir : il doit pointer vers un fichier.exou.exsexistant (par exemplemix.exs), tandis quemix run --no-haltexécute tout votre projet Mix.
Port et hôte pour les sites web et les API
Square Cloud définit la variable d’environnementPORT à 80 et HOST à 0.0.0.0. Votre serveur web doit écouter sur ce port et sur toutes les interfaces réseau. Phoenix le fait en production grâce au config/runtime.exs qu’il génère ; avec Plug ou Bandit, lisez System.get_env("PORT") au démarrage du serveur.
Préparer le projet
Fichiers requis
squarecloud.app, à la racine du ZIP.mix.exs, obligatoire : un envoi sans ce fichier échoue avecINVALID_DEPENDENCY.mix.lock, pour que le serveur récupère les mêmes versions de dépendances que votre machine.- Votre code source, généralement dans
lib/etconfig/.
Ce qu’il faut exclure
_build/: des fichiers compilés pour votre machine. Square Cloud compile le projet sous Linux.deps/:mix deps.getrécupère à nouveau les dépendances sur le serveur.
Guides des frameworks
Phoenix
Déployer
Via le tableau de bord
1
Accéder à la page d'upload
Accédez à la page d’upload et téléversez le fichier zip de votre projet.
2
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.
Si vous téléversez un projet web, veillez à sélectionner « Publication Web » et à définir un sous-domaine pour votre projet.
3
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.
Une fois le déploiement effectué, vous pouvez suivre l’état et les logs de votre projet depuis le tableau de bord.

4
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
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.
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.1
Installer la CLI
Installez la CLI Square Cloud. Si vous l’avez déjà, exécutez la même commande pour la mettre à jour :
2
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.
3
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 Pour téléverser un zip que vous avez créé vous-même, passez-le avec
squarecloud.ignore, puis l’envoie :--file :4
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 :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.
Prochaines étapes
Variables d'environnement
Gardez les secrets et les paramètres hors de votre code et lisez-les à l’exécution.
Domaine personnalisé
Servez votre application sur votre propre domaine, à partir du plan Standard.
Dépannage
Corrigez une application qui ne démarre pas ou un site qui ne répond pas.

