Manage Your Laravel Schedule From A Web Dashboard

Last update: May 19, 2022

Laravel Totem

Build Status License

Introduction

Join the chat at https://gitter.im/laravel-totem/Lobby

Manage your Laravel Schedule from a pretty dashboard. Schedule your Laravel Console Commands to your liking. Enable/Disable scheduled tasks on the fly without going back to your code again.

Documentation

Compatiblity Matrix

Laravel Totem
8.x 8.x
7.x 7.x
6.x 6.x
5.8 5.x
5.7 4.x
5.6 3.x
5.5 2.x
5.4 1.x

Installing

Totem requires Laravel v5.4 and above, please refer to the above table for compatability. Use composer to install totem to your Laravel project

composer require studio/laravel-totem

Laravel Totem supports auto package discovery for Laravel v5.5+, therefore service provider registration is not required in Laravel v5.5+

Add TotemServiceProvider to the providers array of your Laravel v5.4 application's config/app.php

Studio\Totem\Providers\TotemServiceProvider::class,

Once Laravel Totem is installed & registered,

  • Run the migration
php artisan migrate
  • Publish Totem assets to your public folder using the following command
php artisan totem:assets
Table Prefix

Totems' tables use generic names which may conflict with existing tables in a project. To alleviate this the .env param TOTEM_TABLE_PREFIX can be set which will apply a prefix to all of Totems tables and their models.

Updating

Please republish totem assets after updating totem to a new version

php artisan totem:assets

Configuration

Cron Job

This package assumes that you have a good understanding of Laravel's Task Scheduling and Laravel Console Commands. Before any of this works please make sure you have a cron running as follows:

* * * * * php /path-to-your-project/artisan schedule:run >> /dev/null 2>&1
Web Dashboard

Laravel Totem's dashboard is inspired by Laravel Horizon. Just like Horizon you can configure authentication to Totem's dashboard. Add the following to the boot method of your AppServiceProvider or wherever you might seem fit.

use Studio\Totem\Totem;

Totem::auth(function($request) {
    // return true / false . For e.g.
    return Auth::check();
});

By default Totem's dashboard only works in local environment. To view the dashboard point your browser to /totem of your app. For e.g. laravel.dev/totem.

Filter Commands Dropdown

By default Totem outputs all Artisan commands on the Create/Edit tasks. To make this dropdown more concise there is a filter config feature that can be set in the totem.php config file.

Example filters

'artisan' => [
    'command_filter' => [
        'stats:*',
        'email:daily-reports'
    ],
],

This feature uses fnmatch syntax to filter displayed commands. stats:* will match all Artisan commands that start with stats: while email:daily-reports will only match the command named email:daily-reports.

This filter can be used as either a whitelist or a blacklist. By default it acts as a whitelist but an option flag can be set to instead act as a blacklist.

'artisan' => [
    'command_filter' => [
        'stats:*',
        'email:daily-reports'
    ],
    'whitelist' => true,
],

If the value of whitelist is false then the filter acts as a blacklist.

'whitelist' => false

Middleware

Laravel Totem uses the default web and api middleware but if customization is required the middleware can be changed by setting the appropriate .env value. These values can be found in config/totem.php.

Making Commands available in Laravel Totem

All artisan commands can be scheduled. If you want to hide a command from Totem make sure you have the hidden attribute set to true in your command. For e.g.

protected $hidden = true;

From L5.5 onwards all commands are auto registered, so this wouldn't be a problem.

Command Parameters

If your command requires arguments or options please use the optional command parameters field. You can provide parameters to your command as a string in the following manner

name=john.doe --greetings='Welcome to the new world'

In the example above, name is an argument while greetings is an option

Console Command

In addition to the dashboard, Totem provides an artisan command to view a list of scheduled task.

php artisan schedule:list

Screenshots

Task List

Task List

Task Details

Task List

Edit Task

Task List

Artisan Command to view scheduled tasks

Task List

Changelog

Important versions listed below. Refer to the Changelog for a full history of the project.

Credits

Bug reports, feature requests, and pull requests can be submitted by following our Contribution Guide.

Contributing & Protocols

License

This software is released under the MIT License.

© 2020 Roshan Gautam, All rights reserved.

GitHub

https://github.com/codestudeo/laravel-totem
Comments
  • 1. Custom commands not showing

    Hi, loving the idea of this package so wanted to give it a go.

    We've got around 15 custom commands which are registered in the Console/Kernel.php and we run via the normal laravel scheduler.

    However none of these commands are showing on the Totem create task screen.

    Is there something we need to do to make these show?

    Thanks

    Reviewed by OwenMelbz at 2017-08-25 09:09
  • 2. Commands Not Running Even Though Listed

    Just switching from manually scheduling tasks into Totem. Everything is imported and php artisan schedule:list shows all commands correctly. However none of the commands run at their scheduled time, though manually executing through Totem does work.

    Trying to debug locally if I create command to simply log an output, it shows up in list:

    image

    • Enabling the command in Kernel.php logs to the log file correctly
    • Enabling the command in Totem does not log anything from the command
    • Enabling the command in both Kernel and Totem shows identical commands scheduled (see below)

    image

    Not sure if there is other configuration missing why this isn't working?

    Laravel Framework: 8.34.0 Laravel Totem: 8.1.1

    Reviewed by s1rc at 2021-03-29 21:22
  • 3. Disable writing to log

    According to the config and the code I can't seem to find a way to disable the Log::info calls being made, which is quickly filling up the laravel-logs which is undesirable for big projects. This is just after enabling totem for 30 minutes in our system:

    image

    Reviewed by joaolisboa at 2018-12-12 15:35
  • 4. [BUG] Schedule page and console list desync

    In our environment, none of our tasks are getting executed anymore. On the page, we have tasks (just a sample of our tasks):

    image

    But notice that the only task that appears to be executing anymore is the Download TV Guide. Which was one of the first tasks added to the system. Most of our tasks look exactly the same: 8/31 was their last execution. Even though they have upcoming scheduled times. This includes tasks that are supposed to run every minute.

    However, the console command: image

    Lists nothing.

    This morning, I ran a composer update to see if it would fix the problem, and no issues with the update. But tasks still aren't running. I checked my crontab:

    * * * * * * php /var/www/html/scheduler/artisan schedule:run >> /var/www/html/scheduler/storage/logs/schedule_runs.log 2>&1

    Which writes to a log file so we can make sure everything is running. And the scheduled task runs.

    Any of the tasks on the page can be run manually by hitting the play button.

    Reviewed by chssmith at 2018-09-03 13:09
  • 5. migration error on alter duration

    Hey,

    after installing and executing "php artisan migrate" i´am getting the following error:

    image

    The point is following migration, which don´t work on postgresql:

    image

    Reviewed by jagDanJu at 2019-11-18 06:40
  • 6. [BUG] overriding multiples arguments;

    Creating at new task: in the field "PARAMETERS (OPTIONAL)" I insert the following information for a custom command that can accept multiple arguments: "seaport=15 typetraffic=05" When i click Execute (to force execution) it works, because it don't use the console. However, when using the console (Laravel's schedule), it errors. I took the liberty to debug the code and found a problem in the file Task.php, method compileParameters. The problem happens because when running on console it doesn't pass named parameters, and in the mentioned method it will override the first parameter with the second as both will have the key 0. Following is a Print of a fix.

    Please inform me if there is another solution.

    Reviewed by JeanCarloLeal at 2017-11-21 18:10
  • 7. Improve "Illuminate\Console\Scheduling\Schedule" configuration

    Right now in the \Studio\Totem\Providers\ConsoleServiceProvider::register method the booted event is being listened and then app is run in console, then new schedules are added into application.

    Proposing to simplify this by:

    1. using \Studio\Totem\Providers\ConsoleServiceProvider::boot method instead of \Studio\Totem\Providers\ConsoleServiceProvider::register method
    2. do the $this->app->resolving(Illuminate\Console\Scheduling\Schedule::class, function (...
    3. don't check for console

    This way whoever wants the schedule class would get it with all schedules already added.

    Not sure though how this thing could be tested or if resolving events are triggered in unit tests.

    Reviewed by aik099 at 2017-09-01 13:39
  • 8. Totem task_frequencies queries present in every request

    Every request made outside of Totem routes still has totem queries such as:

    select
      *
    from
      `totem_task_frequencies`
    where
      `totem_task_frequencies`.`task_id` = 1
      and `totem_task_frequencies`.`task_id` is not null
    

    and

    select
      *
    from
      `totem_frequency_parameters`
    where
      `totem_frequency_parameters`.`frequency_id` in (1)
    

    Is there a reason these queries and cache hits are running on all requests?

    Reviewed by s1rc at 2021-08-17 21:03
  • 9. route:call

    Hey,

    I am trying to run it with the comand route:call and using this as parameter: /api/v1/test?api_key=1234567890

    The response is The "/api/v1/test?api_key" argument does not exist. Note that the api_key values is omitted on the error message.

    The same command: php artisan route:all /api/v1/test?api_key=1234567890 runs on the command line.

    What am I missing?

    Thanks,

    Reviewed by sergionader at 2019-10-14 21:14
  • 10. schedule task not running

    Hello i am working on laravel 5.6 and i am using totem "studio/laravel-totem": "v3.3.1". the issue is totem task is not firing. i have checked with every minute schedlue task and between but no luck. and all my kerrnal task is running

    please help me i need this is working urgently Screenshot from 2019-07-25 16-17-17

    Reviewed by ankit-aresourcepool at 2019-07-25 10:47
  • 11. Undefined variable: errors

    Undefined variable: errors (View: D:\web projects\marketing\server\vendor\studio\laravel-totem\resources\views\tasks\index.blade.php)

    please help how to solve this problem

    Reviewed by raakkan at 2018-03-27 13:57
  • 12. Task type "Expression" not working properly

    In new task configuration, when custom cron expression is filled, tasks are not working properly. image (2) For example, if cron is set to run at 14:00, then it is started every minute.

    Reviewed by deniskd at 2022-05-18 07:14
  • 13. Column not found: 1054 Unknown column 'run_in_background'

    Hi, when i try to save a task i have this error: Column not found: 1054 Unknown column 'run_in_background' in 'field list' (SQL: insert into totem_tasks [...])

    Did anyone have the same error?

    Reviewed by TelMercher at 2022-03-21 15:40
Dispatcher is a Laravel artisan command scheduling tool used to schedule artisan commands within your project so you don't need to touch your crontab when deploying.
Dispatcher is a Laravel artisan command scheduling tool used to schedule artisan commands within your project so you don't need to touch your crontab when deploying.

Dispatcher Dispatcher allows you to schedule your artisan commands within your Laravel project, eliminating the need to touch the crontab when deployi

May 3, 2022
A course database lookup tool and schedule building web application for use at Rochester Institute of Technology.

CSH ScheduleMaker A course database lookup tool and schedule building web application for use at Rochester Institute of Technology. Built, maintained

Oct 16, 2021
Schedule and unschedule eloquent models elegantly without cron jobs
Schedule and unschedule eloquent models elegantly without cron jobs

Laravel Schedulable Schedule and Unschedule any eloquent model elegantly without cron job. Salient Features: Turn any Eloquent Model into a schedulabl

Feb 13, 2022
Crunz is a framework-agnostic package to schedule periodic tasks (cron jobs) in PHP using a fluent API.

Crunz Install a cron job once and for all, manage the rest from the code. Crunz is a framework-agnostic package to schedule periodic tasks (cron jobs)

May 20, 2022
Manage your Laravel Task Scheduling in a friendly interface and save schedules to the database.
Manage your Laravel Task Scheduling in a friendly interface and save schedules to the database.

Documentation This librarian creates a route(default: /schedule) in your application where it is possible to manage which schedules will be executed a

May 7, 2022
Manage all your cron jobs without modifying crontab. Handles locking, logging, error emails, and more.

Jobby, a PHP cron job manager Install the master jobby cron job, and it will manage all your offline tasks. Add jobs without modifying crontab. Jobby

May 16, 2022
Laravel-Tasks is a Complete Build of Laravel 5.2 with Individual User Task Lists
 Laravel-Tasks is a Complete Build of Laravel 5.2 with Individual User Task Lists

An app of tasks lists for each individual user. Built on Laravel 5.2, using 5.2 authentication and middleware. This has robust verbose examples using Laravel best practices.

Apr 8, 2022
Task Scheduling with Cron Job in Laravel

About Laravel Laravel is a web application framework with expressive, elegant syntax. We believe development must be an enjoyable and creative experie

Oct 16, 2021
A better way to create complex batch job queues in Laravel.

Relay A better way to create complex batch job queues in Laravel. Installation composer require agatanga/relay Usage Example Let's say you have the fo

Apr 2, 2022
Manage Your Laravel Schedule From A Web Dashboard
Manage Your Laravel Schedule From A Web Dashboard

Introduction Manage your Laravel Schedule from a pretty dashboard. Schedule your Laravel Console Commands to your liking. Enable/Disable scheduled tas

May 14, 2022
Laracon Schedule a command-line tool that gives you the Laracon Online schedule in your timezone.
Laracon Schedule a command-line tool that gives you the Laracon Online schedule in your timezone.

Laracon Schedule a command-line tool that gives you the Laracon Online schedule in your timezone. ?? Quick start Requires PHP 7.4+ # First, install: c

Dec 13, 2021
ControlPanel's Dashboard is a dashboard application designed to offer clients a management tool to manage their pterodactyl servers.
ControlPanel's Dashboard is a dashboard application designed to offer clients a management tool to manage their pterodactyl servers.

Features PayPal Integration Email Verification Audit Log Admin Dashboard User/Server Management Store (credit system) Vouchers and so much more! Contr

May 15, 2022
Dispatcher is a Laravel artisan command scheduling tool used to schedule artisan commands within your project so you don't need to touch your crontab when deploying.
Dispatcher is a Laravel artisan command scheduling tool used to schedule artisan commands within your project so you don't need to touch your crontab when deploying.

Dispatcher Dispatcher allows you to schedule your artisan commands within your Laravel project, eliminating the need to touch the crontab when deployi

May 3, 2022
Dispatcher is a Laravel artisan command scheduling tool used to schedule artisan commands within your project so you don't need to touch your crontab when deploying.
Dispatcher is a Laravel artisan command scheduling tool used to schedule artisan commands within your project so you don't need to touch your crontab when deploying.

Dispatcher Dispatcher allows you to schedule your artisan commands within your Laravel project, eliminating the need to touch the crontab when deployi

May 3, 2022
Simple Arabic Laravel Dashboard , has basic settings and a nice layout . to make it easy for you to create fast dashboard
Simple Arabic Laravel Dashboard , has basic settings and a nice layout . to make it easy for you to create fast dashboard

Simple Arabic Laravel Dashboard ✅ Auto Seo ✅ Optimized Notifications With Images ✅ Smart Alerts ✅ Auto Js Validations ✅ Front End Alert ✅ Nice Image V

May 23, 2022
A course database lookup tool and schedule building web application for use at Rochester Institute of Technology.

CSH ScheduleMaker A course database lookup tool and schedule building web application for use at Rochester Institute of Technology. Built, maintained

Oct 16, 2021
1Pilot.io, a universal dashboard to effortlessly manage all your Laravel applications
1Pilot.io, a universal dashboard to effortlessly manage all your Laravel applications

Website · Free Trial · Pricing · Documentation · API · Feedback · Support [You] What are you, strange being? [1Pilot] Greetings, traveller. I am 1Pilo

Mar 30, 2022
👨🏻‍🚀 A command-line tool that gives you the Alpine Day 2021 schedule in your timezone. 🚀
👨🏻‍🚀 A command-line tool that gives you the Alpine Day 2021 schedule in your timezone. 🚀

Alpine Day Schedule a command-line tool that gives you the Alpine Day 2021 schedule in your timezone. ?? Quick start Requires PHP 7.4+ # First, instal

Jun 10, 2021
Schedule your OLX searches and get notified by email when something new is published 📆
Schedule your OLX searches and get notified by email when something new is published 📆

Olx.ba search scheduler Missing scheduler for Olx.ba searches. Production-ready small web application which notifies you by email when something new i

Dec 24, 2021
Wordpress Plugin to show a small amount of events in an easy to use calender/schedule

Wordpress Plugin to show a small amount of events in an easy to use calender/schedule

Feb 7, 2022