2020-05-18 01:30:15 +08:00
< h3 align = "center" >
2020-07-05 23:20:27 +08:00
< img src = "https://steamuserimages-a.akamaihd.net/ugc/1297549742976925024/97F3CBA92B2FEF3652F5A06EC90FB5FF89E5D224/" alt = "Logo" / >
2020-05-18 01:30:15 +08:00
< / h3 >
2020-04-25 22:37:19 +08:00
2020-05-18 01:30:15 +08:00
---
2020-04-25 22:37:19 +08:00
2022-03-21 00:25:13 +08:00
## [Demo](https://status.leons.dev)
2022-02-18 04:52:59 +08:00
# Quick start
2022-02-18 04:51:09 +08:00
2022-02-18 05:00:47 +08:00
## Docker
2022-02-18 04:51:09 +08:00
2022-03-20 23:49:08 +08:00
* `docker run --restart unless-stopped -it -d --name ward -p 4000:4000 -e WARD_PORT=4000 -e WARD_THEME=dark --privileged antonyleons/ward`
2022-03-21 00:07:25 +08:00
* Go to localhost:4000 in web browser
2022-02-18 04:51:09 +08:00
2022-03-21 02:10:44 +08:00
Also see the example [docker-compose.yml ](https://github.com/AntonyLeons/Ward/blob/main/docker-compose.yml ) file in the root directory.
2022-02-18 05:00:47 +08:00
## Java
2022-02-18 05:01:47 +08:00
Download the latest release from [here ](https://github.com/AntonyLeons/Ward/releases/latest )
2022-02-18 04:51:09 +08:00
```console
java -jar ward.jar
```
2022-02-18 05:00:47 +08:00
### About
2020-05-18 01:39:12 +08:00
2020-11-16 05:06:47 +08:00
Ward is a simple and and minimalistic server monitoring tool. Ward supports adaptive design system. Also it supports dark theme.
2020-07-02 04:54:33 +08:00
It shows only principal information and can be used, if you want to see nice looking dashboard instead looking on bunch of numbers and graphs.
2020-05-18 01:19:23 +08:00
Ward works nice on all popular operating systems, because it uses [OSHI ](https://github.com/oshi/oshi ).
2020-05-27 03:44:52 +08:00
**All features tested on:** `Windows` `Linux`
2020-05-18 05:48:16 +08:00
< p align = "center" >
2020-08-28 03:20:04 +08:00
< img src = "https://steamuserimages-a.akamaihd.net/ugc/1601547572022736987/1D8D2E576D957DDB9CE34E13D5944AF841E8AAD8/" alt = "Preview Image" / >
2020-05-27 01:02:56 +08:00
< h7 align = "center" > Preview Image< / h7 >
2020-05-18 05:48:16 +08:00
< / p >
2020-05-18 05:39:38 +08:00
2020-05-18 01:30:15 +08:00
---
2020-04-25 22:37:19 +08:00
2020-05-27 01:02:56 +08:00
### Features
< table >
< tr >
2020-05-27 03:05:03 +08:00
< td width = "600.5" > Processor name< / td >
2020-05-27 03:00:27 +08:00
< td rowspan = "5" >
2020-08-28 03:20:04 +08:00
< img src = "https://steamuserimages-a.akamaihd.net/ugc/1601547572022743136/D62DF59CFA60F5749F2DC7BFE5E9256BCF59E066/" alt = "Card 1" align = "center" / >
2020-05-27 01:02:56 +08:00
< / td >
< / tr >
< tr >
2020-05-27 01:57:52 +08:00
< td > Processor utilization percentage< / td >
2020-05-27 01:02:56 +08:00
< / tr >
< tr >
2020-05-27 01:57:52 +08:00
< td > Processor cores count (Logical and physical ones)< / td >
2020-05-27 01:02:56 +08:00
< / tr >
< tr >
2020-07-20 18:17:21 +08:00
< td > Current frequency of the processor< / td >
2020-05-27 01:02:56 +08:00
< / tr >
< tr >
2020-05-27 01:57:52 +08:00
< td > Does the processor supports 64-bit instructions< / td >
2020-05-27 01:02:56 +08:00
< / tr >
< / table >
2020-05-18 01:39:12 +08:00
2020-05-27 01:14:05 +08:00
< br >
2020-05-27 01:02:56 +08:00
< table >
< tr >
2020-05-27 03:05:03 +08:00
< td width = "600.5" > Type of operating system and it's version< / td >
2020-05-27 03:00:27 +08:00
< td rowspan = "5" >
2020-08-28 03:20:04 +08:00
< img src = "https://steamuserimages-a.akamaihd.net/ugc/1601547572022744630/F9E0CACAA81C882B2F4E401E65090BE9F1FE96F6/" alt = "Card 2" align = "center" / >
2020-05-27 01:02:56 +08:00
< / td >
< / tr >
< tr >
2020-05-27 01:57:52 +08:00
< td > RAM utilization percentage< / td >
2020-05-27 01:02:56 +08:00
< / tr >
< tr >
2020-05-27 01:57:52 +08:00
< td > Amount of total installed RAM< / td >
2020-05-27 01:02:56 +08:00
< / tr >
< tr >
2020-07-20 18:17:21 +08:00
< td > Generation of the installed RAM (If you have dmidecode)< / td >
2020-05-27 01:02:56 +08:00
< / tr >
< tr >
2020-05-27 01:57:52 +08:00
< td > Current processes count< / td >
2020-05-27 01:02:56 +08:00
< / tr >
< / table >
2020-05-18 01:39:12 +08:00
2020-05-27 01:14:05 +08:00
< br >
2020-05-27 01:02:56 +08:00
< table >
< tr >
2020-05-27 03:05:03 +08:00
< td width = "600.5" > Host0 storage name< / td >
2020-05-27 03:00:27 +08:00
< td rowspan = "5" >
2020-08-28 03:20:04 +08:00
< img src = "https://steamuserimages-a.akamaihd.net/ugc/1601547572022746249/D6C5612E2D6AB759CC10438C2D93F7EC80F83D83/" alt = "Card 3" align = "center" / >
2020-05-27 01:02:56 +08:00
< / td >
< / tr >
< tr >
2020-05-27 01:57:52 +08:00
< td > Storage utilization percentage< / td >
2020-05-27 01:02:56 +08:00
< / tr >
< tr >
2020-07-20 18:17:21 +08:00
< td > Total current storage installed (Including external drives)< / td >
2020-05-27 01:02:56 +08:00
< / tr >
< tr >
2020-05-27 02:13:46 +08:00
< td > Installed disks count< / td >
2020-05-27 01:02:56 +08:00
< / tr >
< tr >
2020-05-27 01:57:52 +08:00
< td > Total amount of virtual memory (Swap in Linux)< / td >
2020-05-27 01:02:56 +08:00
< / tr >
< / table >
2020-05-18 01:39:12 +08:00
2020-05-27 03:00:27 +08:00
< br >
< table >
< tr >
2020-05-27 03:14:12 +08:00
< td width = "916.5" >
2020-08-28 03:20:04 +08:00
< img src = "https://steamuserimages-a.akamaihd.net/ugc/1601547572022740496/79ED24E5E626C7029DA4BDEFFBB04C3E0BF61DB1/" alt = "Card 4" align = "center" / >
2020-05-27 03:00:27 +08:00
< / td >
< / tr >
< tr >
2020-05-27 03:27:11 +08:00
< td >
2020-07-20 18:17:21 +08:00
This block contain uptime and chart sections. Uptime represent time since last boot on Linux, and time between hard resets on Windows.
2020-07-22 07:20:37 +08:00
Also it have paginator which can be useful to get author contacts.
2020-07-20 18:17:21 +08:00
Chart section display last fifteen seconds of server utilization. (Proccesor, ram, storage)
You can hide separated datasets by clicking on rectangles on the top right corner of chart section.
2020-05-27 03:27:11 +08:00
< / td >
2020-05-27 03:00:27 +08:00
< / tr >
< / table >
2020-05-18 01:19:23 +08:00
---
2020-05-18 01:39:12 +08:00
2020-05-18 01:40:44 +08:00
### Installation
2022-02-18 01:07:23 +08:00
2020-06-13 10:37:19 +08:00
Create your own jar
2020-06-12 19:00:38 +08:00
2022-02-18 01:34:05 +08:00
1. Clone the project
2. Import project in your IDE as Maven project
3. mvn clean package
4. jar will be in the target folder
2020-06-12 19:00:38 +08:00
2020-06-13 10:37:19 +08:00
< br >
Run jar file
2022-02-18 01:34:05 +08:00
1. Create you own jar as described above
2. Execute jar on Windows or Linux with administrative rights
3. Enter localhost:4000 and set up application
< br >
Build for Docker
1. Clone the project
2. docker build --tag ward
2022-03-21 00:28:35 +08:00
3. docker run --restart unless-stopped -it -d --name ward -p 4000:4000 -e WARD_PORT=4000 -e WARD_THEME=dark --privileged ward
4. Go to localhost:4000 in web browser
2022-02-24 07:11:37 +08:00
### Config
2022-03-20 23:49:08 +08:00
If you want to change Ward's configuration, you can edit `setup.ini` . When using Docker, use the environment variables `WARD_NAME` ,`WARD_THEME`, `WARD_PORT` to automatically regenerate this file at startup. Using any environment variable listed will enable the defaults below and immediately start Ward without the GUI setup.
2022-02-24 07:11:37 +08:00
| Setting | Description | Default |
|------------|------------------------------|---------|
2022-03-20 23:49:08 +08:00
| serverName | Name shown in the interface. | Ward |
| theme | Either `light` or `dark` . | light |
2022-02-24 07:11:37 +08:00
| port | Port to listen on. | 4000 |
2022-03-20 23:49:08 +08:00
Environment variables take priority and will regenerate this file with your variables. If no environment variables are set, `setup.ini` is generated once you navigate to Ward's webpage and complete the initial setup. You can also make this file yourself before starting Ward, and place it in the same directory.
2022-02-24 07:11:37 +08:00
For example:
2022-03-21 00:28:35 +08:00
2022-02-24 07:11:37 +08:00
```ini
[setup]
serverName = my-server
theme = dark
port = 8200
```