From 9816efae44c331380b6f7a7ebac37e245cdf6368 Mon Sep 17 00:00:00 2001 From: alse Date: Fri, 27 May 2016 12:00:26 -0700 Subject: [PATCH] Readme --- README.md | 52 +------------------------------------ README/README.md | 51 ++++++++++++++++++++++++++++++++++++ README/issues.md | 10 +++++++ nginx.md => README/nginx.md | 0 4 files changed, 62 insertions(+), 51 deletions(-) mode change 100644 => 120000 README.md create mode 100644 README/README.md create mode 100644 README/issues.md rename nginx.md => README/nginx.md (100%) diff --git a/README.md b/README.md deleted file mode 100644 index d2b5257..0000000 --- a/README.md +++ /dev/null @@ -1,51 +0,0 @@ -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. - -![flow](http://alseambusher.github.io/files/flow.gif) - -1. Easy setup -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 (NEW) - -Read [this](http://lifepluslinux.blogspot.in/2015/06/crontab-ui-easy-and-safe-way-to-manage.html) to see more details. - -##Setup - - npm install crontab-ui - crontab-ui - -###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](http://2.bp.blogspot.com/-kU8K-suZYMY/VX1Ml5b_JOI/AAAAAAAABEo/MAfgg7hWEz8/s1600/1.png) - -###Backup and restore crontab - -Keep backups of your crontab in case you mess up. -![backup](http://3.bp.blogspot.com/-qHxCbtNny9I/VX1M7k5UE3I/AAAAAAAABEw/cpiPgS9-gXo/s1600/2.png) - -###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](http://2.bp.blogspot.com/-trpHt_etz5I/VX1NyElIicI/AAAAAAAABE4/GTZFBCfybLk/s1600/3.png) - -But make sure to take a backup before importing. - -###See when the job is going to run next. -![future](http://4.bp.blogspot.com/-gN-wLmhd5Os/VX6fQ5wM2LI/AAAAAAAABcA/_Ej0PqrByBU/s1600/next.gif) - -###Separate error log support for every job -![logs](http://alseambusher.github.io/files/crontab_ui_log_feature.gif) - -###Contribute -Fork Crontab UI and contribute to it. Pull requests are encouraged. - -###License -[MIT](LICENSE.md) - diff --git a/README.md b/README.md new file mode 120000 index 0000000..9c67526 --- /dev/null +++ b/README.md @@ -0,0 +1 @@ +README/README.md \ No newline at end of file diff --git a/README/README.md b/README/README.md new file mode 100644 index 0000000..d2b5257 --- /dev/null +++ b/README/README.md @@ -0,0 +1,51 @@ +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. + +![flow](http://alseambusher.github.io/files/flow.gif) + +1. Easy setup +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 (NEW) + +Read [this](http://lifepluslinux.blogspot.in/2015/06/crontab-ui-easy-and-safe-way-to-manage.html) to see more details. + +##Setup + + npm install crontab-ui + crontab-ui + +###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](http://2.bp.blogspot.com/-kU8K-suZYMY/VX1Ml5b_JOI/AAAAAAAABEo/MAfgg7hWEz8/s1600/1.png) + +###Backup and restore crontab + +Keep backups of your crontab in case you mess up. +![backup](http://3.bp.blogspot.com/-qHxCbtNny9I/VX1M7k5UE3I/AAAAAAAABEw/cpiPgS9-gXo/s1600/2.png) + +###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](http://2.bp.blogspot.com/-trpHt_etz5I/VX1NyElIicI/AAAAAAAABE4/GTZFBCfybLk/s1600/3.png) + +But make sure to take a backup before importing. + +###See when the job is going to run next. +![future](http://4.bp.blogspot.com/-gN-wLmhd5Os/VX6fQ5wM2LI/AAAAAAAABcA/_Ej0PqrByBU/s1600/next.gif) + +###Separate error log support for every job +![logs](http://alseambusher.github.io/files/crontab_ui_log_feature.gif) + +###Contribute +Fork Crontab UI and contribute to it. Pull requests are encouraged. + +###License +[MIT](LICENSE.md) + diff --git a/README/issues.md b/README/issues.md new file mode 100644 index 0000000..60b4573 --- /dev/null +++ b/README/issues.md @@ -0,0 +1,10 @@ +Issues +====== + +You can submit issues in the [issue tracker](https://github.com/alseambusher/crontab-ui/issues) of the repository. + +###Common issues +__crontab-ui is running but is not accessible on browser__ - +This is usually because the place where your crontab-ui is installed does not give access to others. It can be resolved by either giving permission to the user (Recommended) or running crontab-ui as root. Refer [this](https://github.com/alseambusher/crontab-ui/issues/8) + +__Hosting crontab-ui : it works on localhost but not outside the server__ - You have to host it using nginx, apache2, etc. Refer [this](nginx.md). diff --git a/nginx.md b/README/nginx.md similarity index 100% rename from nginx.md rename to README/nginx.md