https://github.com/spikehd/procchi
Stupid simple, in-memory system monitoring, accessible from the web
https://github.com/spikehd/procchi
Last synced: 11 months ago
JSON representation
Stupid simple, in-memory system monitoring, accessible from the web
- Host: GitHub
- URL: https://github.com/spikehd/procchi
- Owner: SpikeHD
- License: gpl-3.0
- Created: 2023-09-24T01:15:32.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-22T00:32:08.000Z (about 2 years ago)
- Last Synced: 2025-01-17T22:44:36.952Z (over 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 389 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Procchi
Stupid simple, in-memory system monitoring, accessible from the web.
https://discord.gg/agQ9mRdHMZ
# Table of Contents
* [Screenshots](#screenshots)
* [Installation](#installation)
* [Usage](#usage)
* [Plugins](#plugins)
* [Examples](#examples)
* [Developing](#developing)
* [Prerequisites](#prerequisites)
* [First Time Setup](#first-time-setup)
* [Develop](#develop)
* [Build](#build)
* [TODO](#todo)
* [Contributing](#contributing)
# Screenshots
Click to expand
# Installation
1. 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.
1a. If you are on a Linux platform, you can move Procchi to `/usr/bin` to make it available system-wide:
```sh
sudo mv procchi /usr/bin
```
3. That's it!
# Usage
Run the binary via terminal to view a full list of options:
```sh
./procchi -h
```
## Plugins
Certain extra features need to be selectively enabled. For example, to enable the `minecraft` and `docker` plugins:
```sh
./procchi -e minecraft,docker
```
Looking for a list of plugins that you can enable? Take a look at this file.
## Examples
```sh
# Start Procchi on port 7766, with test authentication credentials
./procchi -p 7766 -u test -k test
# (If `-u` and `-k` are not specified, Procchi will prompt for credentials before deploying the web server, which is reccommended)
# Start Procchi on the default port (6565), and have it retain a max of 50 elements in metric history for each metric
./procchi -m 50
# Start Procchi configured to update every 10 seconds (instead of the default of 5 seconds)
./procchi -r 10
# Start procchi with the access address pointing to the external IP address of the machine
./procchi -a
```
# Developing
## Prerequisites
* Node.js (20.x) or Bun (latest)
* Cargo/Rust (latest)
## First time setup
1. Clone the repository
2. Install frontend dependencies
```sh
cd frontend
npm install
cd ..
```
3. That's it!
## Develop
To start in dev mode:
```sh
# If you have "bun" installed
bun run start:bun
# Otherwise
npm run start
```
## Build
To build a release:
```sh
# If you have "bun" installed
bun run build:bun
# Otherwise
npm run build
```
# TODO
* [ ] Better mobile formatting
* [ ] "Plugins" for specific process types
* [x] Minecraft Server(s)
* [ ] Docker containers
* [ ] Logs (nginx, apache, syslog, etc.)
# Contributing
Issues, PRs, etc. are all welcome!