https://github.com/yoanbernabeu/cronify

Simply monitor your Cron
https://github.com/yoanbernabeu/cronify

cron monitoring symfony tool

Last synced: 15 days ago
JSON representation

Simply monitor your Cron

• Host: GitHub
• URL: https://github.com/yoanbernabeu/cronify
• Owner: yoanbernabeu
• License: mit
• Created: 2022-03-10T12:44:00.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2022-11-25T09:06:14.000Z (over 2 years ago)
• Last Synced: 2025-03-27T01:11:13.868Z (about 1 month ago)
• Topics: cron, monitoring, symfony, tool
• Language: PHP
• Homepage:
• Size: 1.54 MB
• Stars: 251
• Watchers: 6
• Forks: 27
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Cronify

Simply monitor your Cron

[![Pipeline-CI](https://github.com/yoanbernabeu/cronify/actions/workflows/ci.yml/badge.svg)](https://github.com/yoanbernabeu/cronify/actions/workflows/ci.yml) [![MIT License](https://img.shields.io/apm/l/atomic-design-ui.svg?)](LICENSE)

![Logo](public/img/logo_ban.png)

---

##  1. Table of Contents

* 1. [Table of Contents](#TableofContents)

* 2. [What is cronify ?](#Whatiscronify)

* 3. [How to install the app ?](#Howtoinstalltheapp)

	* 3.1. [Prerequisites](#Prerequisites)

	* 3.2. [Clone and install](#Cloneandinstall)

	* 3.3. [Create a new User](#CreateanewUser)

* 4. [How to use ?](#Howtouse)

	* 4.1. [Create a new App](#CreateanewApp)

	* 4.2. [Create a new Job](#CreateanewJob)

	* 4.3. [Get Cron Code snippet](#GetCronCodesnippet)

* 5. [How to quickly test Cronify?](#HowtoquicklytestCronify)

	* 5.1. [ Create a docker-compose.yml](#Createadocker-compose.yml)

	* 5.2. [Start containers](#Startcontainers)

	* 5.3. [Launch your browser and have fun !](#Launchyourbrowserandhavefun)

* 6. [ Build your own Docker image](#BuildyourownDockerimage)

* 7. [License](#License)

---

##  2. What is cronify ?

Cronify is a simple tool to monitor the execution of your cron jobs.

The use is super simple:

1. Declare one or more applications

2. Declare one or more jobs for your applications

3. For each job, you only have to touch three addresses to log the execution:

    - An address to start a cron

    - An address to stop a cron

    - An address to indicate an error

##  3. How to install the app ?

Cronify is a simple Symfony/PHP/PostgreSQL application.

This documentation offers a simplified installation FOR DEVELOPMENT ONLY with Docker. You can do without it if you already have PostgreSQL.

###  3.1. Prerequisites

- [PHP 8.1](https://www.php.net/downloads.php)

- [Composer](https://getcomposer.org/)

- [Docker](https://www.docker.com/)

- [Make](https://www.gnu.org/software/make/)

- [Symfony CLI](https://symfony.com/download)

###  3.2. Clone and install

```bash

git clone https://github.com/yoanbernabeu/Cronify.git

cd Cronify

make install

```

###  3.3. Create a new User

User creation is possible from the command line.

```bash

symfony console app:create-user [email protected] password

```

##  4. How to use ?

Only THREE steps to get your cron job monitoring addresses !

###  4.1. Create a new App

![Create App](.doc/create_app.gif)

###  4.2. Create a new Job

![Create Job](.doc/create_job.gif)

###  4.3. Get Cron Code snippet

![Get Cron Code snippet](.doc/get_cron_code_snippet.gif)

##  5. How to quickly test Cronify?

We offer you a quick method to test the application with the use of a preconfigured Docker container.

###  5.1.  Create a docker-compose.yml

```yaml

version: '3'

services:

  database:

    image: postgres:${POSTGRES_VERSION:-13}-alpine

    environment:

      POSTGRES_DB: ${POSTGRES_DB:-app}

      POSTGRES_PASSWORD: ${POSTGRES_PASSWORD:-ChangeMe}

      POSTGRES_USER: ${POSTGRES_USER:-symfony}

    volumes:

      - db-data:/var/lib/postgresql/data:rw

  app:

    image: yoanbernabeu/cronify:latest

    ports:

      - "8080:80"

    environment:

      DATABASE_URL: postgres://${POSTGRES_USER:-symfony}:${POSTGRES_PASSWORD:-ChangeMe}@database:5432/${POSTGRES_DB:-app}

volumes:

  db-data:

```

###  5.2. Start containers

```bash

docker-compose up -d

```

###  5.3. Launch your browser and have fun !

- Go to http://localhost:8080

- Login with :

	- username: [email protected]

	- password: password

##  6.  Build your own Docker image

If you want to build your own Docker image, we provide a make command that you **need to adapt to your context**.

*Do not run the command without modifications, you would not have the rights to upload the image to the Docker Hub.*

```bash

make docker-build-and-push

```

##  7. License

See the bundled [LICENSE](LICENCE) file.