README

Craft Cloud 扩展

欢迎来到 Craft Cloud！

此存储库包含 craftcms/cloud Composer 包的源代码，该包是运行我们的第一方托管平台 Craft Cloud 上的 Craft 项目所必需的。

安装后，扩展会自动引导自身，并根据检测到的环境进行必要的应用配置更改。

🌩️ 云: 无需担心基础设施设置——数据库、队列、缓存和会话配置将由您处理。
💻 本地开发: Craft 在您最喜欢的开发环境中正常运行。

✨ 想了解更多关于 Cloud 的信息，请查看我们的网站——或者直接通过 Craft Console 开始。想了解扩展如何使您的应用为 Cloud 准备就绪？请阅读知识库中的 Cloud 扩展深入探讨。

安装

您可以通过运行 php craft setup/cloud 在任何现有的 Craft 4.6+ 项目中安装 Cloud 扩展。Craft 将添加 craftcms/cloud 包并运行扩展的设置向导。

提示

此过程包括创建一个 craft-cloud.yaml 配置文件，该文件有助于 Cloud 理解您项目的结构，并确定您的项目在构建和运行时将使用哪些 PHP 和 Node 版本。

当您将项目部署到 Cloud 时，将运行 cloud/up 命令，该命令将包装 Craft 内置的 up 命令并添加缓存和会话表（如果尚未存在）。

文件系统

设置项目资产时，请使用提供的 Craft Cloud 文件系统类型。有关在 Cloud 项目中管理资产的信息，请参阅管理 Cloud 项目中的资产。

开发者功能

模板助手

`cloud.artifactUrl()`

生成在构建和部署过程中上传到 CDN 的资源的 URL。

{# Output a script tag with a build-specific URL: #}
<script src="{{ cloud.artifactUrl('dist/js/app.js') }}"></script>

{# You can also use the extension-provided alias: #}
{% js '@artifactBaseUrl/dist/js/app.js' %}

有关如何使用 artifact URLs 的更多信息，请参阅使用 artifact URLs。

`cloud.isCraftCloud`

当应用检测到它在 Cloud 基础设施上运行时为 true，否则为 false。

{% if cloud.isCraftCloud %}
  Welcome to Cloud!
{% endif %}

别名

除了 Craft 提供的别名之外，还提供了以下别名。

`@web`

在云上，@web 别名确保是每个 HTTP 上下文的正确环境 URL，无论是预览域名还是自定义域名。

`@artifactBaseUrl`

等同于 cloud.artifactUrl()，这允许项目配置设置利用动态的、构建特定的 CDN URL。

配置

大多数配置（针对 Craft 和扩展本身）都直接通过云基础设施通过环境覆盖来处理。这些选项仅提供参考，并在平台外部的实用性有限。

这些选项也可以通过以 CRAFT_CLOUD_ 开头的环境覆盖来设置。

craftcms / cloud

维护者

详情