Skip to main content

​
🚀 Introduction

  • Before you begin, make sure Ruby is installed on your system. If you don’t have it yet, you can download it from the official Ruby website, or use version managers such as rbenv or rvm.
  • Next, you’ll need to create an account on Square Cloud, which can be done through the login page. You can create an account with your email, GitHub, or both.
  • Finally, you must have an active paid plan on your account. You can view our plans and purchase one according to your needs here.

​
⚙️ Creating the squarecloud configuration file

Learn more: how to create the configuration file for Square Cloud.

The squarecloud.app file is a configuration file used to configure your application; it defines the name, description, version, main file, and more.

​
📄 Required Files

  • main.rb (Example main file — your Ruby entrypoint).
  • Gemfile (Dependencies file, if you use Bundler).
  • Gemfile.lock (Generated by Bundler; recommended to include for reproducible builds).
  • squarecloud.app (file that contains Square Cloud configuration).

​
▶️ Starting the Application

  • If the START field is not defined in the configuration file, Square Cloud will run ruby MAIN, where MAIN refers to the Ruby file (for example main.rb). If the START field is defined, its value will be executed directly. For apps using Bundler, it’s common to set START to bundle exec ruby main.rb or another appropriate start command. For more information about configuration file parameters, visit configuration parameters.

​
🖥️ Preparing Project for Upload

Before hosting your project on Square Cloud, you must first have the files of your project properly configured, so that you can host it later.
The configuration (squarecloud.app/.config) file must be located in the root of the zip file. Otherwise, Square Cloud will not be able to find it during deployment.

​
📤 Uploading Project to Square Cloud

After preparing your project files, you can now upload them to Square Cloud and host your project.
  • Dashboard Upload
  • CLI Upload
Access the Square Cloud Dashboard and upload your project files.
If you continue facing technical difficulties, our specialized support team is available to assist you. Contact us and we'll be happy to help you resolve any issue.