f9a153c5fd
* add env check * Create Ward.run.xml * enable one port and theme fixes * fix edge case * env setup * remove unnecessary check * update docs 2.1.0 |
||
---|---|---|
.github/workflows | ||
.run | ||
src/main | ||
.gitignore | ||
Dockerfile | ||
LICENSE | ||
README.md | ||
pom.xml |
README.md
Quick start
Docker
docker run --restart unless-stopped -it -d --name ward -p 4000:4000 -e WARD_PORT=4000 -e WARD_THEME=dark --privileged antonyleons/ward
- Go to localhost:4000 in web browser, input the same application port
- If you get error after being redirected to application port try hitting refresh
Java
Download the latest release from here
java -jar ward.jar
About
Ward is a simple and and minimalistic server monitoring tool. Ward supports adaptive design system. Also it supports dark theme. 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. Ward works nice on all popular operating systems, because it uses OSHI.
All features tested on: Windows
Linux
Features
Processor name | |
Processor utilization percentage | |
Processor cores count (Logical and physical ones) | |
Current frequency of the processor | |
Does the processor supports 64-bit instructions |
Type of operating system and it's version | |
RAM utilization percentage | |
Amount of total installed RAM | |
Generation of the installed RAM (If you have dmidecode) | |
Current processes count |
Host0 storage name | |
Storage utilization percentage | |
Total current storage installed (Including external drives) | |
Installed disks count | |
Total amount of virtual memory (Swap in Linux) |
This block contain uptime and chart sections. Uptime represent time since last boot on Linux, and time between hard resets on Windows. Also it have paginator which can be useful to get author contacts. 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. |
Installation
Create your own jar
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
Run jar file
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
Build for Docker
1. Clone the project
2. docker build --tag ward
3. docker run --rm -it --name ward -p 4000:4000 -p <application port>:<application port> --privileged ward
4. Go to localhost:4000 in web browser, input the same application port
5. If you get error after being redirected to application port try hitting refresh
Config
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.
Setting | Description | Default |
---|---|---|
serverName | Name shown in the interface. | Ward |
theme | Either light or dark . |
light |
port | Port to listen on. | 4000 |
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.
For example:
[setup]
serverName = my-server
theme = dark
port = 8200