diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 000000000..907511205 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,32 @@ +--- +name: Bug Report +about: Create a report to help us improve +title: "[BUG] " +labels: bug +assignees: rcourtman +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Environment (please complete the following information):** + - Pulse Version: [e.g., v3.0.2] + - Proxmox VE Version: [e.g., 8.1.4] + - Browser [e.g., Chrome 120, Firefox 119] + - OS Hosting Pulse [e.g., Docker on Debian 12, LXC on Proxmox, Node.js on Ubuntu 22.04] + +**Additional context** +Add any other context about the problem here. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 000000000..f2ed25897 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,19 @@ +--- +name: Feature Request +about: Suggest an idea for this project +title: "[FEATURE] " +labels: enhancement +assignees: rcourtman +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..219ac5115 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,36 @@ + + +## Description + + +## Related Issue + + + + +Fixes # (*issue number*) + +## Motivation and Context + + + +## How Has This Been Tested? + + + + +## Screenshots (if appropriate): + +## Types of changes + +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to change) + +## Checklist: + + +- [ ] My code follows the code style of this project. +- [ ] I have read the **CONTRIBUTING** document. +- [ ] I have added tests to cover my changes (if applicable). +- [ ] All new and existing tests passed (if applicable). \ No newline at end of file diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 000000000..5dbb213ac --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,129 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, religion, or sexual identity +and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the + overall community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or + advances of any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email + address, without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +[INSERT CONTACT METHOD]. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series +of actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or +permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within +the community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.0, available at +[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html]. + +Community Impact Guidelines were inspired by [Mozilla's code of conduct +enforcement ladder]. + +For answers to common questions about this code of conduct, see the FAQ at +[https://www.contributor-covenant.org/faq]. Translations are available at +[https://www.contributor-covenant.org/translations]. + +[homepage]: https://www.contributor-covenant.org +[Mozilla's code of conduct enforcement ladder]: https://github.com/mozilla/diversity \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..4f3a361af --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,26 @@ +# Contributing to Pulse + +Thank you for your interest in contributing to Pulse! We appreciate your help. Here are some guidelines to follow: + +## Reporting Bugs + +- Please ensure the bug was not already reported by searching on GitHub under [Issues](https://github.com/rcourtman/Pulse/issues). +- If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/rcourtman/Pulse/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample or an executable test case** demonstrating the expected behavior that is not occurring. +- Use the "Bug Report" issue template if available. + +## Suggesting Enhancements + +- Open a new issue using the "Feature Request" template. +- Clearly describe the enhancement you are proposing and why it would be beneficial. +- Provide examples or mockups if possible. + +## Pull Requests + +- Fork the repository and create your branch from `main`. +- Ensure your code adheres to the project's existing style. +- If you've added code that should be tested, add tests. +- Ensure the test suite passes (if applicable). +- Make sure your code lints (if linters are set up). +- Issue that pull request! + +We will review your pull request and provide feedback. Thank you for your contribution! \ No newline at end of file diff --git a/README.md b/README.md index 542182797..9683f0ed5 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,9 @@ # Pulse Logo Pulse for Proxmox VE +[![GitHub release (latest by date)](https://img.shields.io/github/v/release/rcourtman/Pulse)](https://github.com/rcourtman/Pulse/releases/latest) +[![License](https://img.shields.io/github/license/rcourtman/Pulse)](LICENSE) +[![Docker Pulls](https://img.shields.io/docker/pulls/rcourtman/pulse)](https://hub.docker.com/r/rcourtman/pulse) + A lightweight monitoring application for Proxmox VE that displays real-time status for VMs and containers via a simple web interface. ![Pulse Dashboard](docs/images/dashboard-screenshot.png) @@ -246,26 +250,20 @@ Once installed, the Pulse application runs as a `systemd` service. You can manag - Simple, responsive web interface. - Efficient polling: Stops polling the Proxmox API when no clients (browsers) are connected, reducing load. - Docker support for easy deployment. +- Support for monitoring multiple distinct Proxmox environments. +- LXC installation script for easy setup. ## 💻 System Requirements -- **Node.js** (for local development/running): Version 16.x or higher recommended. -- **Docker & Docker Compose** (for containerized deployment): Recent versions recommended. -- **Network**: Connectivity between the Pulse server and your Proxmox server(s). +- **Node.js:** Version 18.x or later recommended. +- **NPM:** Compatible version with Node.js. +- **Docker & Docker Compose:** Latest stable versions recommended if using container deployment. +- **Proxmox VE:** Version 7.x or 8.x recommended (tested primarily on 8.x). +- **Web Browser:** Modern evergreen browser (Chrome, Firefox, Edge, Safari). -## 👥 Contributing +## 👋 Contributing -Contributions are welcome! Please follow standard fork-and-pull-request workflow. Refer to the main repository's contributing guidelines if available. - -1. **Fork the repository** -2. **Create a feature branch**: -```bash -git checkout -b feature/YourFeatureName -``` -3. **Make your changes** -4. **Commit your changes**: `git commit -m 'Add some feature'` -5. **Push to the branch**: `git push origin feature/YourFeatureName` -6. **Open a Pull Request** +Contributions are welcome! Please read our [Contributing Guidelines](CONTRIBUTING.md) before submitting pull requests or opening issues. ## 📜 License