bitkarrot / scheduler Goto Github PK

View Code? Open in Web Editor NEW

8.0 4.0 4.0 319 KB

LNBits extension - Automate Payments or any API Call on a scheduled interval

License: MIT License

Python 61.66% HTML 38.34%

automation bitcoin hacktoberfest lightning lnbits api crontab payments

scheduler's Introduction

Scheduler extension

lnbits scheduler extension [previously: crontabs]

IMPORTANT:

The user that runs LNBits server MUST have crontab -e permissions in order to read/write to crontab file.
This extension should be limited to admin account(s).
min version 0.12.*

Video Demo

LNBitsSchedulerVideo.mp4

Overview:

Add, Edit, Delete and Monitor your scheduled Jobs from the Main Panel.

Create a job Dialog Box.

Schedule a specific http call with a specific timed interval.

Create a new job by clicking "New Scheduled Job"
Fill the options for your new SCHEDULED JOB
- Enter a Name for your Job
- Select an action (GET/PUT/POST/DEL)
- Enter the URL
- Add any headers if required
- Add body data if required, leave blank if there is no body (e.g. for DELETE)
- enter the scheduled time/day you want to run your job. You can use crontab.guru to help validate your cron schedules.
Save your scheduled job and return to the main page to test the job (Orange) or start the job (Green arrow)
All methods for controlling your job are on the main panel [Start/Stop, Edit, Test, View Logs and Delete]

NOTE: Jobs may not run automatically on creation depending on the release version. You will need to start and stop the jobs on the main panel [see image above]. If you are unfamiliar with how the 5 slot scheduling works, visit this resource: https://crontab.guru

There are three sets of logs:

Individual Job Logs - these are viewable by clicking on the blue info icons on the main panel.
Test job Logs - this is for testing the job and the result is not recorded to the database only to the test log file.
Complete Extension Logs - This will show all errors and all events, these are viewable by clicking on the "View all logs" button, located the top of the main panel.

scheduler's People

Contributors

Stargazers

Watchers

Forkers

motorina0 doktorshift arcbtc michilis

scheduler's Issues

convert to proper unit test.

Convert this test file to a proper pytest unit test

https://github.com/bitkarrot/scheduler/blob/main/tests/cron_handler_test.py

rename everything to scheduler

rename from crontabs to scheduler in all files.

[Bug] refresh page - job status

refreshing page changes the job status of jobs running.
need to fix this so that it doesn't reset the job status

clean up artifacts from copied ext

clean up naming artifacts and unused methods from user manager ext which was the template for this repo originally
refactor any relevant parts.

add option to run local script

add an option to run a local python script if a single Rest API call is insufficient for application

[Feature] add multistage requests

Add option for multiple http requests with results chained together

Add logging to scheduler

Add crontab loggin on backend
Add crontab logging visibility on front end

API end points to command

add LNBits API end point selection to command sector
directions TBD from vlad

fix start/stop job on UI

fix the javascript

set environment variables in dialog box

Set Environment Variables on front end UI, connect to cron_handler
Add option in cron_handler to remove environment variables.
these are global environment variables.
Individual job env variables do not exist yet, this would be a future feature.

frontend crontab validation + feature

Add validation checks on frontend js for crontab string
add shortcuts for hourly, daily etc crontab formats.

Scheduler Action

each time a cron job is triggered it should invoke one action
the action is a REST HTTP call
- please see below some screens from Postman
- we can have something similar
- the example below calls an API that updates a certain extension to the latest version
  - the API does not exist yet, is for demo purposes only
we should not add support for OS wise actions (like rmdir) for now (keep it simple(r))
the result of the job execution should be saved in a table (HTTP success status and response body if any)
- this way the user can check that the action was executed at the correct time with the correct params

Call Config:

Call Body

get rid of raw in templates.

get rid of {%raw%} similar to what is discussed here

https://github.com/lnbits/lnbits/pull/2130/files

test project1

Failed to install extension scheduler (v0.1.1). 500 INTERNAL SERVER ERROR

unfortunately I get this error when I hit install, tried also with 0.1.0 same error.

no further informations available, can you help out and point into right direction?

lnbits 0.12.4 running on citadel node

[Future request]: change logo

Thoughts:

All the cron tabs which will be executed save you time and give you more power. Its a little bit like changing the settings.
The logo clarifies something else on the first view.

Improvment:

Something like that