logo

安装

通过 Composer 安装 Spark

许可证

在安装 Spark 之前,您需要购买 Spark 许可证。您可以通过 Spark 仪表板购买 Spark 许可证。

要开始安装 Spark,请将 Spark 存储库添加到应用程序的 composer.json 文件中

json
"repositories": [
    {
        "type": "composer",
        "url": "https://spark.laravel.net.cn"
    }
],

接下来,您可以将 laravel/spark-paddlelaravel/spark-stripe 包添加到 composer.json 文件中所需的包列表中

json
"require": {
    "php": "^8.2",
    "laravel/framework": "^11.0",
    "laravel/spark-paddle": "^5.0"
},

更新 composer.json 文件后,在您的控制台终端中运行 composer update 命令

bash
composer update

运行 composer update 时,系统会提示您提供 Spark 网站的登录凭据。这些凭据将验证您的 Composer 会话是否具有下载 Spark 源代码的权限。为了避免手动输入这些凭据,您可以创建一个 Composer auth.json 文件,并在其中使用您的 API 令牌 代替您的密码

json
{
    "http-basic": {
        "spark.laravel.com": {
            "username": "[email protected]",
            "password": "your-api-token"
        }
    }
}

您可以使用以下命令通过终端快速创建 auth.json 文件。如前所述,您可以通过 Spark 仪表板 创建 API 令牌。此令牌可以用作创建 Composer auth.json 文件时密码的替代品

bash
composer config http-basic.spark.laravel.com [email protected] your-api-token

auth.json 文件

您不应该将应用程序的auth.json文件提交到源代码管理中。

通过 Composer 安装包后,运行spark:install Artisan 命令

bash
php artisan spark:install

最后,运行migrate Artisan 命令

bash
php artisan migrate

Stripe Billables

如果您使用的是 Spark 的 Stripe 版本,并且计划对除App\Models\User模型以外的模型进行计费,则应在运行迁移命令之前遵循这些说明

最后,您需要配置 Stripe 或 Paddle Webhook,以便这些服务可以通过 Webhook 与您的本地应用程序进行通信。要开始使用,请阅读我们关于Stripe WebhookPaddle Webhook的专门文档。Webhook 在本地开发和生产环境中都需要。

就是这样!接下来,您可以导航到应用程序的config/spark.php配置文件,并开始配置您的 Spark 安装。

在持续集成 (CI) 环境中验证 Spark

不建议将您的auth.json文件存储在项目的版本控制存储库中。但是,您可能希望在 CI 环境(如Chipper CI)中下载 Spark。例如,您可能希望对创建的任何自定义工具运行测试。为了在这些情况下验证 Spark,您可以使用 Composer 在 CI 系统的管道中设置配置选项,注入包含用于登录 Spark 仪表板的凭据的环境变量和有效的Spark 仪表板 API 令牌

sh
composer config http-basic.spark.laravel.com ${SPARK_USERNAME} ${SPARK_API_TOKEN}

已过期许可证

如果您的 Spark 许可证已过期,并且您不想续订许可证,则您的composer.json文件需要指定许可证过期之前发布的 Spark 的最后一个版本

json
"require": {
    "php": "^8.2",
    "laravel/framework": "^11.0",
    "laravel/spark-paddle": "5.y.z"
},