Skip to main content
Le runtime Ruby exécute des bots, des workers, des API et des sites web Rails. Square Cloud installe vos gems avec Bundler et démarre votre application avec Ruby.

Avant de commencer

  • Ruby sur votre machine. Si ce n’est pas encore le cas, téléchargez-le depuis le site officiel de Ruby, ou utilisez un gestionnaire de versions comme rbenv ou rvm.
  • 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.
Un fichier de configuration complet pour chaque type d’application :
squarecloud.app

Ce que Square Cloud exécute

  • Si le champ START n’est pas défini dans le fichier de configuration, Square Cloud exécutera ruby MAIN, où le fichier spécifié dans MAIN est le fichier Ruby (par exemple main.rb). Si le champ START est défini, la valeur qu’il contient sera exécutée directement. Il est courant de définir START sur bundle exec ruby main.rb ou une autre commande de démarrage adaptée. Pour plus d’informations sur les paramètres du fichier de configuration, consultez les paramètres de configuration.
  • Avant de démarrer l’application, Square Cloud exécute bundle install pour installer les gems listées dans votre Gemfile.
  • Le runtime définit RACK_ENV=production : les applications Rack comme Rails et Sinatra démarrent donc en mode production.
Bundler lit ses réglages depuis les variables d’environnement, qui sont chargées avant l’exécution de bundle install. Pour exclure en production les groupes de gems inutiles, définissez la variable BUNDLE_WITHOUT=development:test.

Port et hôte pour les sites web et les API

Square Cloud définit la variable d’environnement PORT à 80 et HOST à 0.0.0.0. Votre serveur doit écouter sur ce port et sur toutes les interfaces réseau. Rails le fait sans modification en production ; avec Puma ou Sinatra, lisez ENV.fetch("PORT", 80) et liez le serveur à 0.0.0.0.

Préparer le projet

Fichiers requis

  • squarecloud.app, à la racine du ZIP.
  • main.rb, ou le fichier défini dans MAIN : votre point d’entrée Ruby.
  • Gemfile, obligatoire : un envoi sans ce fichier échoue avec INVALID_DEPENDENCY.
  • Gemfile.lock, généré par Bundler : incluez-le pour que le serveur installe les mêmes versions de gems.
Le fichier de configuration (squarecloud.app) doit se trouver à la racine du fichier zip. Sinon, Square Cloud ne pourra pas le trouver lors du déploiement.

Ce qu’il faut exclure

  • vendor/bundle et .bundle : des gems installées pour votre machine. Square Cloud exécute bundle install sur le serveur.
  • log/ et tmp/, lorsque votre application les crée.

Guides des frameworks

Ruby on Rails

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.
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.
Téléversement d'une application vers Square Cloud
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 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.
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 squarecloud.ignore, puis l’envoie :
Pour téléverser un zip que vous avez créé vous-même, passez-le avec --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.
Votre application ne démarre pas ? Consultez le guide de dépannage pour les causes les plus courantes et leurs solutions.

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.

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.