🚀 Introduction
- Avant de commencer, assurez-vous que Ruby est installé sur votre système. Si ce n’est pas encore le cas, vous pouvez le télécharger depuis le site officiel de Ruby, ou utiliser des gestionnaires de versions comme rbenv ou rvm.
- Ensuite, vous devrez créer un compte sur Square Cloud, ce qui peut être fait via la page de connexion. Vous pouvez utiliser votre e-mail, GitHub, ou les deux pour créer le compte.
- Enfin, vous devez disposer d’un forfait payant actif sur votre compte. Vous pouvez consulter nos forfaits et en acheter un selon vos besoins ici.
⚙️ Configuration du fichier squarecloud.app
Si vous téléversez votre application via le site Web de Square Cloud, vous pouvez ignorer cette section. Le site crée automatiquement le fichier de configuration
squarecloud.app pour vous.En savoir plus : comment créer le fichier de configuration pour Square Cloud.
Le fichier squarecloud.app est un fichier de configuration qui sera utilisé pour
configurer votre application ; il servira à définir le nom, la description,
la version, le fichier principal, entre autres choses.
📄 Fichiers requis
- main.rb (Exemple de fichier principal — votre point d’entrée Ruby).
- Gemfile (Fichier de dépendances, si vous utilisez Bundler).
- Gemfile.lock (Généré par Bundler ; recommandé de l’inclure pour des builds reproductibles).
- squarecloud.app (fichier contenant la configuration Square Cloud).
▶️ Comment démarrer votre application
- Si le champ
STARTn’est pas défini dans le fichier de configuration, Square Cloud exécuteraruby MAIN, où le fichier spécifié dansMAINest le fichier Ruby (par ex.main.rb). Si le champSTARTest défini, sa valeur sera exécutée directement. Dans les applications utilisant Bundler, il est courant de définirSTARTcommebundle exec ruby main.rbou une autre commande de démarrage appropriée. Pour plus d’informations sur les paramètres du fichier de configuration, consultez les paramètres de configuration.
Pour les applications Ruby utilisant Bundler, il est important de configurer correctement les variables d’environnement afin d’optimiser le processus d’installation des dépendances sur Square Cloud. Square Cloud exécute l’installation de bundler à l’aide de variables d’environnement. Pour exclure les groupes de gems inutiles en production, configurez la variable
BUNDLE_WITHOUT=development:test. Cela aide également à supprimer les deprecations de Bundler 2.x.🖥️ Préparation du projet
Avant d’héberger votre projet sur Square Cloud, vérifiez que les fichiers du projet sont correctement configurés pour l’hébergement.📤 Comment héberger votre projet
Maintenant que vous avez préparé tous les fichiers de votre projet Ruby, l’étape suivante consiste à les téléverser sur Square Cloud et à mettre votre application en ligne. Il existe plusieurs façons de téléverser, mais nous en aborderons deux : via le Dashboard ou via la CLI.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, vous devez créer un fichier de configuration nommésquarecloud.app à la racine de votre projet. Ce fichier contiendra la configuration nécessaire à votre projet.
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
Tout d’abord, vous devez avoir la CLI installée dans votre environnement. Si ce n’est pas encore le cas, exécutez la commande suivante dans votre terminal :Si vous l’avez déjà, nous vous recommandons de la mettre à jour. Pour cela, exécutez la commande suivante dans votre terminal :
- Windows
- Linux, macOS et WSL
2
S'authentifier
Maintenant, pour vous authentifier et utiliser les autres commandes de la CLI, vous trouverez votre clé d’autorisation ici en cliquant sur « Request API Key ». Après avoir obtenu votre clé d’autorisation, exécutez la commande suivante :
3
Téléverser votre projet
Enfin, pour déployer votre application sur Square Cloud à l’aide de la CLI, vous devez exécuter la commande suivante :Ou si vous avez créé le zip manuellement, vous pouvez utiliser :
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.