Deploy a Go App, API or Bot

​

Before you begin

• Go on your machine. If you don’t have it, download it from the official Go 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=main.go
MEMORY=256
VERSION=recommended
DISPLAY_NAME=My bot

MAIN=main.go
MEMORY=512
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 go run MAIN to compile and run the Go file specified in MAIN. If the START field is defined, the value in it will be executed directly. For more information about configuration file parameters, visit configuration parameters.
• go run MAIN compiles only the file set in MAIN. If your main package is split across several files, set START=go run ..
• Square Cloud does not run go mod tidy: run it on your machine before uploading so that go.mod and go.sum list every dependency. go run downloads those modules when the app starts.

​

Port and host for websites and APIs

package main

import (
	"fmt"
	"log"
	"net/http"
	"os"
)

func main() {
	// Square Cloud sets PORT=80. ":" + port listens on all network interfaces.
	port := os.Getenv("PORT")
	if port == "" {
		port = "80"
	}

	http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
		fmt.Fprintln(w, "Hello, World!")
	})

	log.Fatal(http.ListenAndServe(":"+port, nil))
}

​

Prepare the project

​

Required files

• squarecloud.app, at the root of the ZIP.
• main.go, or the file set in MAIN.
• go.mod, or go.work for a workspace: an upload without either fails with INVALID_DEPENDENCY.
• go.sum, required when your module has dependencies.

​

What to leave out

• Compiled binaries (.exe files or the output of go build): Square Cloud builds the program itself.
• vendor/, unless your build uses it on purpose: go run downloads the modules listed in go.sum.

​

Troubleshooting

​

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