{"id":16620692,"url":"https://github.com/spikehd/procchi","last_synced_at":"2025-08-01T05:38:15.752Z","repository":{"id":196935913,"uuid":"695710378","full_name":"SpikeHD/Procchi","owner":"SpikeHD","description":"Stupid simple, in-memory system monitoring, accessible from the web","archived":false,"fork":false,"pushed_at":"2024-04-22T00:32:08.000Z","size":398,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-17T22:44:36.952Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SpikeHD.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"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}},"created_at":"2023-09-24T01:15:32.000Z","updated_at":"2024-08-11T20:08:36.000Z","dependencies_parsed_at":"2024-04-22T01:41:29.860Z","dependency_job_id":"392f0d17-1025-401b-98e1-9316d111cad1","html_url":"https://github.com/SpikeHD/Procchi","commit_stats":null,"previous_names":["spikehd/procchi"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpikeHD%2FProcchi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpikeHD%2FProcchi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpikeHD%2FProcchi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpikeHD%2FProcchi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SpikeHD","download_url":"https://codeload.github.com/SpikeHD/Procchi/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242995916,"owners_count":20218829,"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":[],"created_at":"2024-10-12T02:44:57.636Z","updated_at":"2025-03-11T08:18:52.041Z","avatar_url":"https://github.com/SpikeHD.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=center\u003e\n  \u003ch1\u003e\n    \u003cimg height=\"100px\" src=\"frontend/src/assets/procchi_icon.png\" /\u003e\n    \u003cbr /\u003e\n    Procchi\n  \u003c/h1\u003e\n\u003c/div\u003e\n\n\u003cdiv align=\"center\"\u003e\n \u003cimg src=\"https://img.shields.io/github/actions/workflow/status/SpikeHD/procchi/build.yml\" /\u003e\n \u003cimg src=\"https://img.shields.io/github/package-json/v/SpikeHD/procchi\" /\u003e\n \u003cimg src=\"https://img.shields.io/github/repo-size/SpikeHD/procchi\" /\u003e\n\u003c/div\u003e\n\u003cdiv align=\"center\"\u003e\n \u003cimg src=\"https://img.shields.io/github/commit-activity/m/SpikeHD/procchi\" /\u003e\n \u003cimg src=\"https://img.shields.io/github/release-date/SpikeHD/procchi\" /\u003e\n \u003cimg src=\"https://img.shields.io/github/stars/SpikeHD/procchi\" /\u003e\n\u003c/div\u003e\n\n\u003cdiv align=\"center\"\u003e\n  Stupid simple, in-memory system monitoring, accessible from the web.\n  \u003cbr /\u003e\n  https://discord.gg/agQ9mRdHMZ\n\u003c/div\u003e\n\n\n# Table of Contents\n\n* [Screenshots](#screenshots)\n* [Installation](#installation)\n* [Usage](#usage)\n  * [Plugins](#plugins)\n  * [Examples](#examples)\n* [Developing](#developing)\n  * [Prerequisites](#prerequisites)\n  * [First Time Setup](#first-time-setup)\n  * [Develop](#develop)\n  * [Build](#build)\n* [TODO](#todo)\n* [Contributing](#contributing)\n\n# Screenshots\n\n\u003cdetails\u003e\n  \u003csummary\u003eClick to expand\u003c/summary\u003e\n  \u003cimg width=\"1676\" alt=\"image\" src=\"https://github.com/SpikeHD/Procchi/assets/25207995/e06f567f-86f2-4fb7-a375-c4b65a448288\"\u003e\n  \u003cimg width=\"1676\" alt=\"image\" src=\"https://github.com/SpikeHD/Procchi/assets/25207995/ebcd8917-c323-4778-96a1-fa04380dab41\"\u003e\n\u003c/details\u003e\n\n# Installation\n\n1. Download a release binary from the [releases page](https://github.com/SpikeHD/procchi/releases) or from [actions](https://github.com/SpikeHD/procchi/actions), and put it somewhere.\n\n   1a. If you are on a Linux platform, you can move Procchi to `/usr/bin` to make it available system-wide:\n    ```sh\n    sudo mv procchi /usr/bin\n    ```\n3. That's it!\n\n# Usage\n\nRun the binary via terminal to view a full list of options:\n\n```sh\n./procchi -h\n```\n\n## Plugins\n\nCertain extra features need to be selectively enabled. For example, to enable the `minecraft` and `docker` plugins:\n\n```sh\n./procchi -e minecraft,docker\n```\n\n\u003ci\u003eLooking for a list of plugins that you can enable? Take a look \u003ca href=\"https://github.com/SpikeHD/Procchi/blob/main/backend/src/plugins/mod.rs#L35\"\u003eat this file.\u003c/a\u003e\u003c/i\u003e\n\n## Examples\n\n```sh\n# Start Procchi on port 7766, with test authentication credentials\n./procchi -p 7766 -u test -k test\n# (If `-u` and `-k` are not specified, Procchi will prompt for credentials before deploying the web server, which is reccommended)\n\n# Start Procchi on the default port (6565), and have it retain a max of 50 elements in metric history for each metric\n./procchi -m 50\n\n# Start Procchi configured to update every 10 seconds (instead of the default of 5 seconds)\n./procchi -r 10\n\n# Start procchi with the access address pointing to the external IP address of the machine\n./procchi -a \u003cmachine IP\u003e\n```\n\n# Developing\n\n## Prerequisites\n\n* Node.js (20.x) or Bun (latest)\n* Cargo/Rust (latest)\n\n## First time setup\n\n1. Clone the repository\n2. Install frontend dependencies\n    ```sh\n    cd frontend\n    npm install\n    cd ..\n    ```\n3. That's it!\n\n## Develop\n\nTo start in dev mode:\n```sh\n# If you have \"bun\" installed\nbun run start:bun\n\n# Otherwise\nnpm run start\n```\n\n## Build\n\nTo build a release:\n```sh\n# If you have \"bun\" installed\nbun run build:bun\n\n# Otherwise\nnpm run build\n```\n\n# TODO\n\n* [ ] Better mobile formatting\n* [ ] \"Plugins\" for specific process types\n  * [x] Minecraft Server(s)\n  * [ ] Docker containers\n  * [ ] Logs (nginx, apache, syslog, etc.)\n\n# Contributing\n\nIssues, PRs, etc. are all welcome!\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspikehd%2Fprocchi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fspikehd%2Fprocchi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspikehd%2Fprocchi/lists"}