necrolog

README

Necrolog 📜

Necrolog is an advanced tool designed to streamline both real-time incident management and post-mortem analysis, enhancing internal operational efficiencies and service quality.

It serves as an essential utility for organizations aiming to maintain high standards of reliability and accountability.

Features 🛠️

• Post-Mortem Analysis: Facilitates a thorough breakdown of incidents to prevent future occurrences and foster continuous improvement.
• Real-Time Incident Management: Offers timely updates during incidents, ensuring teams can react swiftly and effectively.
• Scheduled Maintenance Reports: Allows planning and communication of maintenance activities to manage and set expectations internally.
• Uptime Showcases: Displays historical uptime data, promoting transparency and trust within teams.

Try it out 🚀

You can try and test the application using Docker Compose. To do this, you need to execute the following commands:

1. Clone the repository:

git clone https://github.com/beyimjan/necrolog.git

1. Create a .env file:

cp .env.example .env

Change the value of TELEGRAM_BOT_TOKEN in the .env file to the token of your Telegram bot. You can create a new bot and get the token by following the instructions here.

1. Create a config.yml file:

cp example_config.yml config.yml

This file contains the configuration of the application. You can change the values of the fields in this file according to your needs.

1. Run the application:

docker-compose up

TODO 📝

• Log changes to resources in the database by user and timestamp
• "Telegram Notifications" feature
• "Incident Comments" feature
• "Incident Metadata" feature
• Calculate uptime for each component over the last 90 days on the main page
• Develop a badge showing the current system status on the main page
• "Technical Works" feature
• Develop pagination for the incident page
• "Event Calendar" feature
  • "Maintenance Calendar" feature
• Develop autocomplete for entering incident metadata
• "Profile Editing" feature
  • "Change Password" feature
• Develop a general settings page for the administrator
• LDAP login
• "Search" feature
• Publish a project demo
• Publish documentation (MkDocs)
  • Create a detailed installation guide for the project
• Design a logo ⏬
• Make failed validation messages user-friendly ⏬

License 📄

This project is licensed under the terms of the MIT license.