Go to file

Suresh Alse 29e98b3e3a Merge branch 'master' into patch-1		5 years ago
.github	Update ISSUE_TEMPLATE.md	8 years ago
README	Update nginx.md	6 years ago
bin	mailing stdout and stderr as attachments	8 years ago
config	adding better default mail config	8 years ago
crontabs	Added error log support	9 years ago
public	new:dev:support run the jobs manually	7 years ago
views	Merge branch 'master' into patch-1	5 years ago
.dockerignore	Updating dockerignore	5 years ago
.gitignore	Added error log support	9 years ago
Dockerfile	Fixing cron not updating inside docker	5 years ago
LICENSE.md	Rename LICENSE.txt to LICENSE.md	9 years ago
Makefile	Fixing cron not updating inside docker	5 years ago
README.md	Adding Docker section to Readme	5 years ago
app.js	Adding support custom for CRON_DB_PATH	5 years ago
app.json	basic structure	10 years ago
crontab.js	Adding support custom for CRON_DB_PATH	5 years ago
docker-compose.yml	Add Docker Compose YAML File	6 years ago
package-lock.json	Security fix for packages	5 years ago
package.json	Fixing cron not updating inside docker	5 years ago
restore.js	Adding a callback for logging error on deleting backup	5 years ago
routes.js	Making url paths relative to enable reverse proxy	5 years ago
supervisord.conf	Using the /etc/crontabs/root file	7 years ago

README.md

Crontab UI

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.

Easy setup. You can even import from existing crontab.
Safe adding, deleting or pausing jobs. Easy to maintain hundreds of jobs.
Backup your crontabs.
Export crontab and deploy on other machines without much hassle.
Error log support.
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

Docker

You can use crontab-ui with docker. You can use the prebuilt images in the dockerhub

docker run -d -p 8000:8000 alseambusher/crontab-ui

You can also build it yourself if you want to customize, like this:

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

If you want to use it with authentication, You can pass BASIC_AUTH_USER and BASIC_AUTH_PWD as env variables

docker run -e BASIC_AUTH_USER=user -e BASIC_AUTH_PWD=SecretPassword -d -p 8000:8000 alseambusher/crontab-ui

You can also mount a folder to store the db and logs.

mkdir -p crontabs/logs
docker run --mount type=bind,source="$(pwd)"/crontabs/,target=/crontab-ui/crontabs/ -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.

Import from existing crontab

Import from existing crontab file automatically.

Backup and restore crontab

Keep backups of your crontab in case you mess up.

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!

But make sure to take a backup before importing.

Separate error log support for every job

Donate

Like the project? Buy me a coffee!

Contribute

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

License

MIT