Download the PHP package vojtasvoboda/oc-webartisan-plugin without Composer
On this page you can find all versions of the php package vojtasvoboda/oc-webartisan-plugin. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download vojtasvoboda/oc-webartisan-plugin
More information about vojtasvoboda/oc-webartisan-plugin
Files in vojtasvoboda/oc-webartisan-plugin
Package oc-webartisan-plugin
Short Description Webartisan plugin for OctoberCMS
License MIT
Homepage https://github.com/vojtasvoboda/oc-webartisan-plugin
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package oc-webartisan-plugin
Web Artisan plugin for OctoberCMS
Plugin allows you to run artisan commands by public URL. You can call this URL by http, curl or wget.
Example: http://www.domain.com/artisan/v1/cache/clear/secret-hash
This could be useful:
- when you don't have SSH access to your server and wants to run some commands
- when you don't have access to /etc/crontab and want to run scheduled tasks from outside
- when you want to run scheduled tasks by online CRON tools like webcron.org etc.
- when you want to run commands by services like IFTTT, Zapier, etc.
- for deployment and automated tasks
Tested with the latest stable OctoberCMS build 419 (with Laravel 5.5).
Important
It is highly recommend to use SSL (https://) when invoking commands with Web Artisan. The secret hash can be stolen if SSL is not used.
Configuration
Before call any command you have to set secret hash at Backend > Settings > System > Web Artisan. Run without secret hash is not possible due to security reasons.
For generating secret hash use some random generator.
Usage
General pattern is:
http://www.domain.com/artisan/v1/{group}/{command}/{secret}
Run command cache:clear by URL:
http://www.domain.com/artisan/v1/cache/clear/1234567890abcdef
Run command schedule:run by curl:
curl http://www.domain.com/artisan/v1/schedule/run/1234567890abcdef
Available commands
Whitelist: auth:clear-resets, cache:clear, october:update, queue:flush, queue:forget, queue:restart, queue:retry, queue:work, route:clear, schedule:run, view:clear.
Wants more? Override plugin's config file and add your commands as you wish.
Queued commands
You can queue commands so they are processed in the background by your queue workers. Before using this method, make sure you have configured your queue and are running a queue listener.
For running queue commands just put prefix queued before command
http://www.domain.com/artisan/v1/queued/{group}/{command}/{secret}
for example
http://www.domain.com/artisan/v1/queued/october/update/1234567890abcdef
TODO
- [ ] pass Artisan to CommandRunner through constructor as Illuminate\Console\Application
- [ ] set hash also by config (when you want to fire october:up on stage server)
Contributing
Please send Pull Request to the master branch.
License
Web artisan plugin is open-sourced software licensed under the MIT license same as OctoberCMS platform.
