badreddine-barradi / cronify

Simply monitor your Cron

Cronify

Simply monitor your Cron

---

1. Table of Contents

• 1. Table of Contents
• 2. What is cronify ?
• 3. How to install the app ?
  • 3.1. Prerequisites
  • 3.2. Clone and install
  • 3.3. Create a new User
• 4. How to use ?
  • 4.1. Create a new App
  • 4.2. Create a new Job
  • 4.3. Get Cron Code snippet
• 5. How to quickly test Cronify?
  • 5.1. Create a docker-compose.yml
  • 5.2. Start containers
  • 5.3. Launch your browser and have fun !
• 6. Build your own Docker image
• 7. 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
• Composer
• Docker
• Make
• Symfony CLI

3.2. Clone and install

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.

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

4.2. Create a new Job

4.3. Get Cron Code snippet

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

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

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.

make docker-build-and-push

7. License

See the bundled LICENSE file.