Deploy a Rust App, API or Bot

​

Before you begin

• Rust on your machine. If you don’t have it, install it from the official Rust website.
• A Square Cloud account: sign up with your email or GitHub.
• An active plan. See the plans and pick the one that fits your project.

​

Configure Square Cloud

MAIN=src/main.rs
MEMORY=512
VERSION=recommended
DISPLAY_NAME=My bot

MAIN=src/main.rs
MEMORY=1024
VERSION=recommended
DISPLAY_NAME=My API
SUBDOMAIN=my-api

​

What Square Cloud runs

• If the START field is not defined in the configuration file, Square Cloud will execute the command cargo run --release to compile and run the code in release mode. If the START field is defined in the configuration file, the value in it will be executed directly. For more information about configuration file parameters, visit configuration parameters.
• MAIN only tells Square Cloud that the project is written in Rust: it must point to an existing .rs file, such as src/main.rs, while cargo run --release builds the whole Cargo project. You can set RUNTIME=rust instead of MAIN.

​

Port and host for websites and APIs

let port = std::env::var("PORT").unwrap_or_else(|_| "80".to_string());
let addr = format!("0.0.0.0:{port}");

​

Prepare the project

​

Required files

• squarecloud.app, at the root of the ZIP.
• Cargo.toml, required: an upload without it fails with INVALID_DEPENDENCY.
• Cargo.lock, so the server builds the same dependency versions.
• src/, with src/main.rs.

​

What to leave out

• target/: build output, often hundreds of megabytes. Square Cloud builds the project itself.

​

Deploy

​

Via dashboard

1

Access the Upload Page

Access the upload page and upload your project zip file.

2

Configure Your Environment

After uploading your zip, you will need to configure the name, main file or runtime environment and other settings for your project.
If you are uploading a web project, make sure to select “Web Publication” and set a subdomain to your project.

3

Deploy Your Project

Finally, click on the “Deploy” button to host your project on Square Cloud.
After deployment, you can monitor your project’s status and logs from the dashboard.

4

Confirm Your App Is Live

Your first deploy usually takes less than a minute. In the dashboard, wait for your application status to show as running and check the logs for any startup errors.
If you deployed a website or API, open https://<your-subdomain>.squareweb.app in your browser: you should see your application responding. If you deployed a bot, send it a command to confirm it is online.

App not starting? See the Troubleshooting guide for the most common causes and fixes.

​

Via CLI

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

npm install -g @squarecloud/cli@latest

squarecloud auth login

squarecloud upload

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

squarecloud app status
squarecloud app logs

​

Next steps

​

Contact us