vojtasvoboda/oc-webartisan-plugin

OctoberCMS的Webartisan插件

1.0.4 2023-06-12 06:59 UTC

This package is not auto-updated.

Last update: 2024-09-14 20:35:37 UTC


README

Codacy Scrutinizer Coverage License

此插件允许您通过公共URL运行Artisan命令。您可以通过http、curl或wget调用此URL。

示例: http://www.domain.com/artisan/v1/cache/clear/secret-hash

这在以下情况下可能很有用

  • 当您没有对服务器的SSH访问权限,但想运行一些命令时
  • 当您没有访问/etc/crontab的权限,但想从外部运行计划任务时
  • 当您想通过在线CRON工具(如webcron.org等)运行计划任务时
  • 当您想通过服务如IFTTT、Zapier等运行命令时
  • 用于部署和自动化任务

已与最新的稳定OctoberCMS构建419(含Laravel 5.5)进行测试。

重要

强烈建议在调用Web Artisan命令时使用SSL(https://)。如果不使用SSL,机密哈希可能会被盗。

配置

在调用任何命令之前,您必须在 后端 > 设置 > 系统 > Web Artisan 中设置秘密哈希。出于安全原因,无法在没有秘密哈希的情况下运行。

要生成秘密哈希,请使用一些随机生成器

用法

一般模式是

http://www.domain.com/artisan/v1/{group}/{command}/{secret}

通过URL运行命令 cache:clear

http://www.domain.com/artisan/v1/cache/clear/1234567890abcdef

通过curl运行命令 schedule:run

curl http://www.domain.com/artisan/v1/schedule/run/1234567890abcdef

可用命令

白名单:auth:clear-resets, cache:clear, october:update, queue:flush, queue:forget, queue:restart, queue:retry, queue:work, route:clear, schedule:run, view:clear.

想要更多? 覆盖插件配置文件 并添加您想要的命令。

队列命令

您可以将命令排队,以便它们在您的队列工作者后台处理。在使用此方法之前,请确保您已配置队列并正在运行队列监听器。

要运行队列命令,只需在命令前加上前缀queued

http://www.domain.com/artisan/v1/queued/{group}/{command}/{secret}

例如

http://www.domain.com/artisan/v1/queued/october/update/1234567890abcdef

待办事项

  • 通过构造函数将Artisan传递给CommandRunner作为Illuminate\Console\Application
  • 通过配置设置哈希(当您想在预发布服务器上执行october:up时)

贡献

请向master分支发送Pull Request。

许可证

Web artisan插件是开源软件,许可协议与OctoberCMS平台相同,采用MIT许可证