diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..02b3feb --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,42 @@ +# Code of Conduct + +CloudMonitor welcomes contributors of all backgrounds and experience levels. +This policy applies to project issues, pull requests, reviews, discussions, +and other spaces where participants represent the project. + +## Expected behavior + +- Be respectful, patient, and considerate. +- Offer specific, constructive feedback about the work. +- Welcome questions and differing perspectives; assume good intent while + remaining accountable for the effect of your words and actions. +- Respect privacy and obtain permission before sharing personal information. +- Accept reasonable requests to stop disruptive behavior. + +## Unacceptable behavior + +Harassment, threats, discrimination, sexualized conduct, personal attacks, +doxxing, sustained disruption, and retaliation against people who report +concerns are not acceptable. + +## Reporting concerns + +Contact a repository maintainer privately using a contact method they publish +on their GitHub profile. If no private channel is listed, open an issue asking +for a private contact channel **without including names, allegations, or other +sensitive details**. Do not post private evidence in public issues. + +If a report involves a maintainer, contact another project maintainer where +possible. Reports should include the relevant context, links, and the outcome +you are seeking. Share only information needed to understand the concern. + +## Enforcement + +Maintainers will review reports fairly, protect confidentiality as far as +practicable, and consider context and severity. They may remove content, issue +a warning, restrict participation temporarily, or ban a participant. Serious +or repeated misconduct may lead directly to removal. + +A person affected by an enforcement decision may ask for reconsideration through +the same private channel, providing relevant new information. Maintainers with +a conflict of interest should step back from the review where possible. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..d3dac80 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,69 @@ +# Contributing to CloudMonitor + +Thanks for helping improve CloudMonitor. Read the [README](README.md), +[Code of Conduct](CODE_OF_CONDUCT.md), and [Security Policy](SECURITY.md) first. + +## Propose a change + +Use GitHub issues for reproducible bugs and focused feature proposals. Include +the affected component, expected and actual behavior, reproduction steps, and +sanitized logs. Discuss substantial architecture or deployment changes before +implementing them. Report vulnerabilities privately as described in SECURITY.md. + +## Local development + +1. Fork or clone the repository and create a branch for one change. +2. Follow the README setup instructions. Copy `.env.example` to `.env` and use + local test credentials. Never commit real credentials, tokens, private keys, + database files, or sensitive telemetry. +3. Install Python dependencies from `backend/requirements.txt` and + `agent/requirements.txt` in a virtual environment. +4. Run `npm ci` in `frontend`, then `npm run dev` for the UI. +5. Use your local environment for testing; do not test failure simulations + against the shared production deployment. + +## Validate your change + +Use the checks relevant to your change. CI is defined in +[ci.yml](.github/workflows/ci.yml). + +For backend/agent changes, run from the repository root with `APP_ENV=test`, +`DATABASE_URL=sqlite:///./test.db`, a test-only JWT secret of at least 32 +characters, and `PYTHONPATH=backend:.` (use `backend;.` on Windows): + +```sh +pytest -v --tb=short tests/ agent/tests/ +``` + +For frontend changes: + +```sh +cd frontend +npm ci +npm run build +``` + +For Compose changes, use `docker compose -f docker-compose.yml config --quiet` +and `docker compose -f docker-compose.prod.yml config --quiet` with placeholder +environment values. Check UI changes in light/dark mode and at mobile widths. + +## Pull requests + +- Explain the problem, resulting behavior, and validation performed. +- Keep changes focused; add meaningful regression tests for behavior changes. +- Include screenshots for visible UI changes and update affected documentation. +- Call out migrations, deployment steps, and rollback considerations. +- Preserve unrelated work and wait for the required CI checks and review. + +Maintainers may request revisions or defer changes outside the project's scope. +Submitting a pull request does not authorize a production deployment. + +## Licensing and assets + +Contributions are submitted under the [Apache License 2.0](LICENSE), unless +explicitly stated otherwise and agreed with maintainers. Submit only work you +have permission to contribute and retain third-party attribution notices. + +The logo source is `docs/Icon.png`; its unchanged web copy is +`frontend/public/cloudmonitor-logo.png`. Keep both copies synchronized when +intentionally replacing the logo. Application branding uses `BrandLogo.jsx`. diff --git a/LICENSE b/LICENSE index 2b39ed6..d645695 100644 --- a/LICENSE +++ b/LICENSE @@ -1,21 +1,202 @@ -MIT License - -Copyright (c) 2026 Cloud Monitor Contributors - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/NOTICE b/NOTICE new file mode 100644 index 0000000..a5e91f4 --- /dev/null +++ b/NOTICE @@ -0,0 +1,5 @@ +CloudMonitor +Copyright 2026 Cloud Monitor Contributors + +Licensed under the Apache License, Version 2.0. See LICENSE. +Third-party dependencies retain their respective licenses and notices. diff --git a/README.md b/README.md index 07c6bd5..75e3b40 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ +

CloudMonitor logo

+ # CloudMonitor A self-hosted observability platform for monitoring Docker hosts and containers. @@ -40,7 +42,7 @@ CloudMonitor combines a React dashboard, a FastAPI backend, PostgreSQL persisten [![React](https://img.shields.io/badge/React-18-61DAFB?logo=react)](https://react.dev/) [![Docker](https://img.shields.io/badge/Docker-Compose-2496ED?logo=docker)](https://www.docker.com/) [![Prometheus](https://img.shields.io/badge/Prometheus-Metrics-E6522C?logo=prometheus)](https://prometheus.io/) -[![License](https://img.shields.io/badge/License-MIT-yellow)](LICENSE) +[![License](https://img.shields.io/badge/License-Apache%202.0-blue)](LICENSE) ## Table of contents @@ -615,4 +617,10 @@ The AWS deployment roles are the target scope for each member, and the optional ## License -CloudMonitor is licensed under the MIT License. See [LICENSE](LICENSE). \ No newline at end of file +CloudMonitor is licensed under the Apache License, Version 2.0. See [LICENSE](LICENSE) and [NOTICE](NOTICE). + +## Community + +- [Contributing guide](CONTRIBUTING.md) +- [Code of Conduct](CODE_OF_CONDUCT.md) +- [Security Policy](SECURITY.md) diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..3cbe91b --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,47 @@ +# Security Policy + +## Supported versions + +Security fixes target the current `main` branch. Older commits, forks, and +unmaintained deployments do not have a separate backport or support commitment. +CloudMonitor is an academic project; response times are best-effort. + +## Report a vulnerability + +Do not disclose exploit details, credentials, or personal data in public issues +or pull requests. Use GitHub's **Security → Report a vulnerability** option if +it is available for this repository. Otherwise, contact a maintainer privately +using a channel published on their GitHub profile. If no channel is available, +open an issue asking only for a private security contact, without vulnerability +details. + +Include the affected commit/version, component, impact, minimal reproduction, +and sanitized evidence. Tell maintainers whether you know of active exploitation. +Coordinate public disclosure after a fix or mitigation is available. Reports +are handled on a best-effort basis; no bounty or response deadline is promised. + +## Safe testing + +Test against a local instance or infrastructure you are authorized to assess. +Do not access another user's data, disrupt the shared demo, run denial-of-service +tests, or use development failure-simulation endpoints against production. +Stop testing if you encounter sensitive data and report the minimum evidence +needed to describe the issue. + +## Deployment precautions + +- Use HTTPS for sign-in and agent enrollment. The hosted HTTPS endpoint is + `https://cloudmonitorsite.duckdns.org`; see [HTTPS setup](docs/HTTPS_SETUP.md). +- Keep `.env`, SSH private keys, JWT secrets, database passwords, and agent + tokens out of Git, screenshots, issue reports, and logs. Rotate exposed values. +- Keep production databases and internal monitoring services off public ports. + Review access to any monitoring routes exposed through the reverse proxy. +- Use explicit CORS origins and keep development simulation features disabled + in production. +- Update dependencies and container images, monitor resource pressure, and + maintain tested database backups. +- Use least-privilege AWS roles and GitHub OIDC for deployment. Review changes + to workflows, IAM permissions, and production configuration before applying. + +Security reports and audits under `docs/security/` record findings at a point +in time; they do not guarantee that every deployment is secure. diff --git a/backend/README.md b/backend/README.md index e676c8e..9d7e16c 100644 --- a/backend/README.md +++ b/backend/README.md @@ -6,7 +6,7 @@ [![FastAPI](https://img.shields.io/badge/FastAPI-0.115+-009688.svg?logo=fastapi)](https://fastapi.tiangolo.com/) [![Docker](https://img.shields.io/badge/Docker-Containerized-2496ED.svg?logo=docker)](https://www.docker.com/) [![Prometheus](https://img.shields.io/badge/Prometheus-Metrics%20Ready-E6522C.svg?logo=prometheus)](https://prometheus.io/) -[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE) +[![License: Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](../LICENSE) --- @@ -225,4 +225,4 @@ The backend natively exports standard Prometheus metrics: ## 9. License -This project is licensed under the [MIT License](LICENSE). +This project is licensed under the [Apache License 2.0](../LICENSE). diff --git a/docs/Icon.png b/docs/Icon.png new file mode 100644 index 0000000..0785a7f Binary files /dev/null and b/docs/Icon.png differ diff --git a/frontend/index.html b/frontend/index.html index dd990d0..acbc662 100644 --- a/frontend/index.html +++ b/frontend/index.html @@ -2,7 +2,7 @@ - + CloudMonitor — Observability Portal diff --git a/frontend/package-lock.json b/frontend/package-lock.json index 2958d74..6b7a4e5 100644 --- a/frontend/package-lock.json +++ b/frontend/package-lock.json @@ -7,6 +7,7 @@ "": { "name": "cloudmonitor-frontend", "version": "1.0.0", + "license": "Apache-2.0", "dependencies": { "@emotion/react": "^11.14.0", "@emotion/styled": "^11.14.1", diff --git a/frontend/package.json b/frontend/package.json index 496f80e..60df00f 100644 --- a/frontend/package.json +++ b/frontend/package.json @@ -1,6 +1,7 @@ { "name": "cloudmonitor-frontend", "private": true, + "license": "Apache-2.0", "version": "1.0.0", "type": "module", "scripts": { diff --git a/frontend/public/cloudmonitor-logo.png b/frontend/public/cloudmonitor-logo.png new file mode 100644 index 0000000..0785a7f Binary files /dev/null and b/frontend/public/cloudmonitor-logo.png differ diff --git a/frontend/src/App.jsx b/frontend/src/App.jsx index e96249d..79aaed4 100644 --- a/frontend/src/App.jsx +++ b/frontend/src/App.jsx @@ -48,6 +48,7 @@ import { import { getMuiTheme } from './theme'; import { api } from './api'; import AuthScreen from './components/AuthScreen'; +import BrandLogo from './components/BrandLogo'; import ConnectDockerModal from './components/ConnectDockerModal'; // Helper for formatting byte sizes (e.g., memory) @@ -500,6 +501,7 @@ export default function App() {
+

Verifying CloudMonitor session...

@@ -534,9 +536,7 @@ export default function App() {