跳转到主要内容

​
什么是配置文件？

配置文件是一个包含应用参数的文件，例如主文件、内存、版本以及其他设置。该文件用于在 Square Cloud 平台上配置和部署你的应用。
squarecloud.app
MAIN=main_file.js
DISPLAY_NAME=I am the configuration file
MEMORY=512
VERSION=recommended

​
创建配置文件

创建配置文件非常简单：只需创建一个名为 squarecloud.app 或 squarecloud.config 的文件，并在其中添加配置参数即可。
1

选择扩展名

配置文件可以有两种扩展名：.app 或 .config。你可以使用 squarecloud.app 或 squarecloud.config，随你喜好。提示：使用 .app 有助于推广 Square Cloud。🥰😂
在 macOS 上，我们推荐使用 .config 扩展名。
注意：.app 或 .config 指的是文件扩展名，而不是文件名。
2

创建文件

使用所选的扩展名创建一个文件，并在其中添加配置参数。

​
配置参数

下面列出了配置文件中可用的所有配置参数。
参数类型可编辑限制用途
MAIN*String❌32 字符定义应用的主文件。例如：index.js、main.py 等。
VERSION*String❌-语言版本（例如：recommended）。
MEMORY*Integer✅-内存量，单位为兆字节。
DISPLAY_NAME*String✅32 字符应用的显示名称。
RUNTIMEString❌-运行时环境。例如：typescript、nodejs、go。
DESCRIPTIONString✅280 字符应用的描述/元数据。
AUTORESTARTBoolean✅-自动重启（true 或 false）。
STARTString✅256 字符自定义启动命令。
SUBDOMAINString✅63 字符网站子域名（如适用）。
可编辑参数（✅）可以在部署后于控制面板中修改。不可编辑参数（❌）需要完整重新上传应用才能更改。

​
配置参数详解

下面详细说明了你可以在配置文件中使用的配置参数。

MAIN [*]

类型：String | 可编辑：❌ | 限制：32 字符定义应用的主文件。
MAIN=index.js

MAIN=src/loaders/index.js
设置此参数后，运行时环境将根据主文件的扩展名进行推断
如果你使用了 START 参数，此设置将被忽略。

MEMORY [*]

类型：Integer | 可编辑：✅ | 限制：最低 256MB（机器人）、512MB（网站）定义你的应用将使用的内存量。
MEMORY=256
该值必须以兆字节（MB）为单位指定。

VERSION [*]

类型：String | 可编辑：❌ | 取值：recommended、latest 或特定版本
为获得最佳稳定性，我们推荐使用 recommended。
定义应用的语言版本。
VERSION=recommended
语言recommendedlatest
Node.js [JS & TS]24.15.026.1.0
Python3.13.133.14.5
JavaJDK 25JDK 25
Elixir1.19.51.19.5
Rust1.95.01.95.0
Ruby4.0.44.0.4
PHP8.5.68.5.6
Go1.26.31.26.3
.NET/C#10.0.810.0.8

DISPLAY_NAME [*]

类型：String | 可编辑：✅ | 限制：32 字符定义应用的显示名称。
DISPLAY_NAME=Admin BOT

DESCRIPTION

类型：String | 可编辑：✅ | 限制：280 字符定义应用的描述。
DESCRIPTION=This bot is designed to help you with your daily tasks.

AUTORESTART

类型：Boolean | 可编辑：✅ | 取值：true、false | 默认值：false定义应用在失败时是否应自动重启。
AUTORESTART=true

SUBDOMAIN

类型：String | 可编辑：✅ | 限制：63 字符 | 默认值：undefined定义你网站的子域名（仅适用于 Web 应用）。
SUBDOMAIN=mysite
最终 URL 将为：mysite.squareweb.app

RUNTIME

类型：String | 可编辑：❌手动定义运行时环境。
RUNTIME=nodejs
请查看下方接受的取值和环境。
环境RUNTIME
Nodejsnodejs、javascript
TypeScripttypescript
Pythonpython
C#/Dotnetc#、dotnet、csharp
Elixirelixir
Javajava
Rustrust
Rubyruby、rb
PHPphp
Golanggo、golang
HTML/CSSstatic、html
如果设置了此参数，你就无需设置 MAIN；改为设置一个自定义的 START 命令即可。

START

类型：String | 可编辑：✅ | 限制：256 字符 | 默认值：undefined定义自定义启动命令。
START=npm run start
此参数会覆盖默认的 MAIN 行为。

​
机器人配置示例

以下是一些机器人的配置示例： 
# Required parameters.
MAIN=index.js
MEMORY=512
VERSION=recommended
DISPLAY_NAME=Robin bot

# Example with all parameters.
MAIN=index.js
MEMORY=512
VERSION=recommended
DISPLAY_NAME=Robin bot
DESCRIPTION=This bot was created to help with your daily tasks.
START=npm run start
AUTORESTART=true

​
网站配置示例

以下是一些网站的配置示例：
网站 URL 将为：mysite.squareweb.app
# Example with all parameters.
MAIN=index.js
MEMORY=1024
VERSION=recommended
DISPLAY_NAME=My site
DESCRIPTION=My site is really cool!
SUBDOMAIN=mysite
START=npm run build && npm run start
AUTORESTART=true
将 next.config.js 作为 MAIN 仅用于让系统将该项目识别为 JavaScript 或 TypeScript 项目（另一个 .ts/.tsx 文件）
# Example for a Next.js site.
MAIN=next.config.js
MEMORY=2048
VERSION=recommended
DISPLAY_NAME=Next.js site
DESCRIPTION=This site was built with Next.js.
SUBDOMAIN=nextjs
START=npm run build && npm run start
AUTORESTART=true