{"id":14573441,"url":"https://github.com/harsxv/tinystatus","last_synced_at":"2025-09-04T10:31:49.496Z","repository":{"id":255629644,"uuid":"851414164","full_name":"harsxv/tinystatus","owner":"harsxv","description":"Tiny status page generated by a Python script","archived":false,"fork":false,"pushed_at":"2024-10-31T03:53:16.000Z","size":127,"stargazers_count":1494,"open_issues_count":4,"forks_count":89,"subscribers_count":6,"default_branch":"master","last_synced_at":"2024-12-30T00:42:48.659Z","etag":null,"topics":["hacktoberfest","hacktoberfest-accepted","hacktoberfest2024","monitoring","monitoring-tool","python","python3","status","status-page"],"latest_commit_sha":null,"homepage":"https://status.harry.id/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/harsxv.png","metadata":{"files":{"readme":"README.md","changelog":"history.html.theme","contributing":".github/CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"harsxv","buy_me_a_coffee":"harsxv"}},"created_at":"2024-09-03T03:54:04.000Z","updated_at":"2024-12-27T06:35:07.000Z","dependencies_parsed_at":"2024-10-24T06:35:07.324Z","dependency_job_id":"1fda40c9-de2a-4253-a863-213d6b8ce382","html_url":"https://github.com/harsxv/tinystatus","commit_stats":null,"previous_names":["harsxv/tinystatus"],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/harsxv%2Ftinystatus","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/harsxv%2Ftinystatus/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/harsxv%2Ftinystatus/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/harsxv%2Ftinystatus/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/harsxv","download_url":"https://codeload.github.com/harsxv/tinystatus/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":231953568,"owners_count":18451173,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hacktoberfest","hacktoberfest-accepted","hacktoberfest2024","monitoring","monitoring-tool","python","python3","status","status-page"],"created_at":"2024-09-07T09:01:43.257Z","updated_at":"2024-12-31T06:31:19.869Z","avatar_url":"https://github.com/harsxv.png","language":"Python","readme":"\u003cdiv align=\"center\" width=\"100%\"\u003e\n    \u003cimg src=\"./assets/android-chrome-192x192.png\" width=\"128\" alt=\"\" /\u003e\n\u003c/div\u003e\n\n# TinyStatus\nTinyStatus is a simple, customizable status page generator that allows you to monitor the status of various services and display them on a clean, responsive web page.\n\nCheck out an online demo https://status.harry.id\n\n| Light Mode | Dark Mode | \n|-|-|\n| ![Light](https://github.com/user-attachments/assets/3ea7b55e-397f-4f7c-8189-64b74a03594b) | ![Dark](https://github.com/user-attachments/assets/92072f9e-1031-4f07-8392-1111df57453a) |\n\n\n## Features\n\n- Monitor HTTP endpoints, ping hosts, and check open ports\n- Responsive design for both status page and history page\n- Customizable service checks via YAML configuration\n- Incident history tracking\n- Automatic status updates at configurable intervals\n- Supports both light and dark themes\n- Supports grouping\n- Cards clickable (optional)\n\n## Prerequisites\n\n- Python 3.11 or higher\n- pip (Python package manager)\n\n## Installation\n\n1. Clone the repository or download the source code:\n   ```\n   git clone https://github.com/harsxv/tinystatus.git\n   cd tinystatus\n   ```\n\n2. Install the required dependencies:\n   ```\n   pip install -r requirements.txt\n   ```\n\n## Configuration\n\n1. Create a `.env` file in the project root and customize the variables:\n   ```\n   MONITOR_CONTINOUSLY=True\n   CHECK_INTERVAL=30\n   MAX_HISTORY_ENTRIES=100\n   LOG_LEVEL=INFO\n   CHECKS_FILE=checks.yaml\n   INCIDENTS_FILE=incidents.md\n   TEMPLATE_FILE=index.html.theme\n   HISTORY_TEMPLATE_FILE=history.html.theme\n   STATUS_HISTORY_FILE=history.json\n   HTML_OUTPUT_DIRECTORY=/var/www/htdocs/status/\n   ```\n\n2. Edit the `checks.yaml` file to add or modify the services you want to monitor.\n   Example:\n   ```yaml\n    - title: 'Group 1'\n      checks:\n        - name: GitHub Home\n          type: http\n          host: https://github.com\n          url: https://docs.github.com/en\n          expected_code: 200\n\n        - name: Google Public DNS\n          type: ping\n          host: 8.8.8.8\n\n        - name: Dummy MySQL Database\n          type: port\n          host: db.example.com\n          port: 3306\n\n       - name: Home Server with Self-Signed Certs\n          type: http\n          host: https://homeserver.local\n          ssc: True\n          expected_code: 200\n   ```\n\n3. (Optional) Customize the `incidents.md` file to add any known incidents or maintenance schedules.\n\n4. (Optional) Modify the `index.html.theme` and `history.html.theme` files to customize the look and feel of your status pages.\n\n## Usage\n\n1. Run the TinyStatus script:\n   ```\n   python tinystatus.py\n   ```\n\n2. The script will generate three files:\n   - `index.html`: The main status page\n   - `history.html`: The status history page\n   - `history.json`: The status history and timestamp data\n\n3. To keep the status page continuously updated, you can run the script in the background:\n   - On Unix-like systems (Linux, macOS):\n     ```\n     nohup python tinystatus.py \u0026\n     ```\n   - On Windows, you can use the Task Scheduler to run the script at startup.\n\n4. Serve the generated HTML files using your preferred web server (e.g., Apache, NGINX, or a simple Python HTTP server for testing).\n\n## Using Docker\n\nIn order to run the script using Docker:\n\n   ```\n    docker build -t tinystatus .\n    docker run -ti --rm --name tinystatus -v \"$PWD\":/usr/src/myapp -w /usr/src/myapp tinystatus\n   ```\n\n## Customization\n\n- Adjust the configuration variables in the `.env` file to customize the behavior of TinyStatus.\n- Customize the appearance of the status page by editing the CSS in `index.html.theme` and `history.html.theme`.\n- Add or remove services by modifying the `checks.yaml` file.\n\n## Porting TinyStatus\n\nTinyStatus porting are available in:\n- Go: https://github.com/annihilatorrrr/gotinystatus\n\n## Contributing\n\n[Contributions](https://github.com/harsxv/tinystatus/contribute) are, of course, most welcome!\n\n## License\n\nThis project is open source and available under the [MIT License](LICENSE).\n","funding_links":["https://github.com/sponsors/harsxv","https://buymeacoffee.com/harsxv"],"categories":["Python"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fharsxv%2Ftinystatus","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fharsxv%2Ftinystatus","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fharsxv%2Ftinystatus/lists"}