AlertFlow

AlertFlow is a monitoring automation platform designed to streamline workflows, manage team members, and monitor project progress. This repository contains both the frontend and backend code for the AlertFlow application.

Table of Contents

• Features
• Preview
• Self Hosting
• Runners
• Project Structure
• Local Development
• Contributing
• License

Features

• Project Management: Projects combine a number of Flows and add the option to invite members and control their access.
• Flows: Create flows to design workflows for your incoming alarms.
• Payloads: Receive incoming alarms from your monitoring infrastructure via payloads and automate them via Flows.
• Runners: Runners execute your workflows and can also be self-hosted.
• Shared Runners: Create runners which can be used for all projects.
• Scalable to your Needs: Runners can be scaled with the Auto Join option
• Team Collaboration: Invite team members, assign roles, and manage permissions.
• Audit Logs: Track changes and activities within projects and flows.

Preview

If you want to checkout AlertFlow before hosting it on your own, have a look at https://alertflow.org

Login Details:

Username: Demo
Password: demo123

Self Hosting

To run your own version of AlertFlow we provide various docker images available at Docker Hub.

• justnz/alertflow:latest - Full version including frontend and backend
• justnz/alertflow:vx.x.x - Versioned release. Also available for the single frontend and backend images
• justnz/alertflow:frontend-latest - Only frontend
• justnz/alertflow:backend-latest - Only backend

Full Version

Config example: config.yaml

docker run -p 80:3000 -v /your/config/path/config.yaml:/etc/alertflow/backend_config.yaml justnz/alertflow:latest

Frontend Only

If you want to run only the frontend of AlertFlow, please provide the backend endpoint via the below env flag.

docker run -p 80:3000 -e NEXT_PUBLIC_API_URL=https://api-url.com justnz/alertflow:frontend-latest

Backend Only

docker run -p 8080:8080 -v /your/config/path/config.yaml:/etc/alertflow/backend_config.yaml justnz/alertflow:backend-latest

Runners

Runners are the key part of AlertFlow and provide the functionality of execution so called Workflows.

To create / run your own runners you require to have a fully set up AlertFlow instance.

Please see the repo Runner for more informations.

Project Structure

The project structure is organized as follows:

• backend: Contains the backend code for handling API requests, database interactions, and business logic.
• frontend: Contains the frontend code for the user interface, including components, pages, and styles.

Local Development

To get started with the AlertFlow project, follow these steps:

Backend

1. Clone the repository:

   git clone git@github.com:AlertFlow/alertflow.git
   cd alertflow

2. Install dependencies:

   cd services/backend && go mod download

3. Create a config.yaml file and add the necessary configuration:

   LogLevel: info
   
   Database:
     Server: localhost
     Port: 5432
     Name: postgres
     User: postgres
     Password: postgres
   
   Encryption:
     Enabled: true
     Key: your-encryption-key
   
   JWT:
     Secret: your-jwt-secret

4. Build and run the backend server:

   $ go build -o alertflow-backend
   $ ./alertflow-backend --config config/config.yaml

Frontend

1. Navigate to the frontend directory:

   cd services/frontend

2. Install dependencies:

   npm install

3. Create a .env.local file and add the necessary environment variables:

   NEXT_PUBLIC_API_URL="https://your-api-url.com"

4. Start the development server:

   npm run dev

Contributing

We welcome contributions to the AlertFlow project! To contribute, follow these steps:

1. Fork the repository.
2. Create a new branch:

   git checkout -b feature/your-feature-name

3. Make your changes and commit them:

   git commit -m "Add your commit message"

4. Push to the branch:

   git push origin feature/your-feature-name

5. Open a pull request on GitHub.

License

This project is licensed under the GNU AFFERO GENERAL PUBLIC LICENSE Version 3. See the LICENSE file for details.