Overview:

Fettle is an open-source status page system that is powered by GitHub Actions, Issues, and Pages. It allows users to create their status page using their GitHub repository. Users can update URLs, set up deployment, change monitoring intervals, report incidents, and contribute to the project.

Features:

• GitHub-Integrated: Fettle is completely integrated with GitHub, utilizing GitHub Actions, Issues, and Pages for status page functionalities.
• Customizable URLs: Users can update and personalize URLs in various configuration files according to their repository.
• Easy Deployment: Setting up Fettle involves enabling GitHub Pages and configuring GitHub Actions for deployment.
• Monitoring Interval: Users have the flexibility to adjust the monitoring interval by modifying a specific configuration file.
• Incident Reporting: Fettle allows users to report incidents by creating a new GitHub issue with a specific label for incident management.
• Hosting on GitHub Pages: The status page is hosted using GitHub Pages, ensuring reliability and accessibility.
• Monitoring and Response: GitHub Workflow monitors the status page regularly, updating response status and time in the repository.
• Contribution Friendly: Users are encouraged to contribute to Fettle by submitting pull requests and reporting bugs or suggestions.

Installation:

1. Fork the Fettle repository to your GitHub account.
2. Update the URLs and names in the urls.cfg file located in public > urls.cfg.
3. Update the incidents, services status, and system status URLs in respective files under src > incidents > hooks and src > services > hooks.
4. Enable GitHub Pages for your forked repository by navigating to Settings > Pages and enabling it for the main branch.
5. Modify the monitoring interval by changing the cron time in the .github > workflows > health-check.yml file.
6. To report an incident, create a new label “incident” in the issues tab and assign it to a new issue.

Summary:

Fettle is a versatile status page system that leverages GitHub’s infrastructure for status monitoring and reporting. With customizable features, easy deployment, and contribution options, Fettle provides a user-friendly solution for managing service status and incidents effectively.