You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
crontab-ui/README.md

4.3 KiB

Crontab UI

Donate npm npm npm npm

Editing the plain text crontab is error prone for managing jobs, e.g., adding jobs, deleting jobs, or pausing jobs. A small mistake can easily bring down all the jobs and might cost you a lot of time. With Crontab UI, it is very easy to manage crontab. Here are the key features of Crontab UI.

flow

  1. Easy setup. You can even import from existing crontab.
  2. Safe adding, deleting or pausing jobs. Easy to maintain hundreds of jobs.
  3. Backup your crontabs.
  4. Export crontab and deploy on other machines without much hassle.
  5. Error log support.
  6. Mailing and hooks support.

Read this to see more details.

Setup

Get latest node from here. Then,

npm install -g crontab-ui
crontab-ui

If you need to set/use an alternative host or port, you may do so by setting an environment variable before starting the process:

HOST=0.0.0.0 PORT=9000 crontab-ui

If you need to apply basic HTTP authentication, you can set user name and password through environment variables:

BASIC_AUTH_USER=user BASIC_AUTH_PWD=SecretPassword

Also, you may have to set permissions for your node_modules folder. Refer this.

If you need to autosave your changes to crontab directly:

crontab-ui --autosave

Setting up with docker:

git clone https://github.com/alseambusher/crontab-ui.git
cd crontab-ui
docker build -t alseambusher/crontab-ui .
docker run -d -p 8000:8000 alseambusher/crontab-ui

Resources

Adding, deleting, pausing and resuming jobs.

Once setup Crontab UI provides you with a web interface using which you can manage all the jobs without much hassle.

basic

Import from existing crontab

Import from existing crontab file automatically. import

Backup and restore crontab

Keep backups of your crontab in case you mess up. backup

Export and import crontab on multiple instances of Crontab UI.

If you want to run the same jobs on multiple machines simply export from one instance and import the same on the other. No SSH, No copy paste!

export

But make sure to take a backup before importing.

Separate error log support for every job

logs

Donate

Like the project? Buy me a coffee!

Contribute

Fork Crontab UI and contribute to it. Pull requests are encouraged.

License

MIT