README.md

StatHub

StatHub is a simple server stat statistics system. It can collect server stats and display them in a simple way.

Run in Ubuntu

The following script will install\update this app on your Ubuntu server. Supports Ubuntu 22.04.

On your Ubuntu server, run the following command:

curl -sL https://gitlab.aiursoft.cn/aiursoft/stathub/-/raw/master/install.sh | sudo bash

Of course it is suggested that append a custom port number to the command:

curl -sL https://gitlab.aiursoft.cn/aiursoft/stathub/-/raw/master/install.sh | sudo bash -s 8080

It will install the app as a systemd service, and start it automatically. Binary files will be located at /opt/apps. Service files will be located at /etc/systemd/system.

Run manually

Requirements about how to run

1. Install .NET 8 SDK and Node.js.
2. Execute npm install at wwwroot folder to install the dependencies.
3. Execute dotnet run to run the app.
4. Use your browser to view http://localhost:5000.

Run in Microsoft Visual Studio

1. Open the .sln file in the project path.
2. Press F5 to run the app.

Run in Docker

First, install Docker here.

Then run the following commands in a Linux shell:

image=hub.aiursoft.cn/aiursoft/stathub
appName=stathub
sudo docker pull $image
sudo docker run -d --name $appName --restart unless-stopped -p 5000:5000 -v /var/www/$appName:/data $image

That will start a web server at http://localhost:5000 and you can test the app.

The docker image has the following context:

Properties	Value
Image	hub.aiursoft.cn/aiursoft/stathub
Ports	5000
Binary path	/app
Data path	/data
Config path	/data/appsettings.json

Run client in Docker

First, install Docker here.

Then run the following commands in a Linux shell:

sudo touch /etc/motd
sudo docker run -d \
    --restart always \
    --name stathub-client \
    --pid host \
    --net host \
    -v /etc/lsb-release:/etc/lsb-release:ro \
    -v /etc/os-release:/etc/os-release:ro \
    -v /etc/motd:/etc/motd:ro \
    -v /etc/hostname:/etc/hostname:ro \
    --privileged \
    -e SERVER_ENDPOINT="https://stathub.aiursoft.cn" \
    hub.aiursoft.cn/aiursoft/stathub-client

Where https://stathub.aiursoft.cn is the endpoint of your StatHub server.

How to contribute

There are many ways to contribute to the project: logging bugs, submitting pull requests, reporting issues, and creating suggestions.

Even if you with push rights on the repository, you should create a personal fork and create feature branches there when you need them. This keeps the main repository clean and your workflow cruft out of sight.

We're also interested in your feedback on the future of this project. You can submit a suggestion or feature request through the issue tracker. To make this process more effective, we're asking that these include more information to help define them more clearly.