Skip to content

Latest commit

 

History

History
60 lines (40 loc) · 3.32 KB

setup.md

File metadata and controls

60 lines (40 loc) · 3.32 KB

Quick Setup

Work fine under Debian, not test other OS

To quickly and easily set up this project with the default configuration, you can use the provided one-click scripts. However, it is recommended to read the documentation before proceeding.

Client

  1. Download the client setup script and execute it with root permission.
  2. The script will perform the following tasks:
    • Attempt to create the directory "/opt/ping-charts".
    • Download the pre-compiled client from the releases page.
    • Download the client template configuration.
    • Download the client systemd service configuration files to "/etc/systemd/system/".

After executing the script, follow these steps:

  1. Rewrite the '/opt/ping-charts/client.yaml' file with your server configuration.
  2. Run the command systemctl start pingChartsClient.timer to start the client. This will ping your targets and upload data to the server once a minute.
  3. If desired, run the command systemctl enable pingChartsClient.timer to make the client start automatically after the OS reboot.

Attention:

  • If you do not change the service configuration file, the client configuration file must be named 'client.yaml'.

Server

  1. Download the server setup script and execute it with root permission.
  2. The script will perform the following tasks:
    • Attempt to create the directory "/opt/ping-charts".
    • Download the pre-compiled server from the releases page.
    • Download the server template configuration.
    • Download the server systemd service configuration file to "/etc/systemd/system/".

After executing the script, follow these steps:

  1. Rewrite the '/opt/ping-charts/server.yaml' file with your client configuration.
  2. Run the command systemctl start pingChartsServer to start the server.
  3. If desired, run the command systemctl enable pingChartsServer to make the server start automatically after the OS reboot.

Attention:

  • If you do not change the service configuration file, the server configuration file must be named 'server.yaml'.
  • The server will run on port 8000.
  • The service will listen for requests from '0.0.0.0'.

Update

After setting up the project by one-click scripts, you can use client-update and server-update to update client and server to the latest version.

Customization

Before making any changes, ensure that you understand what you are doing.

If you are not satisfied with the default settings, you can customize the service files to meet your needs.

Firstly, ensure that the client and server are running correctly. For more information, refer to the Usage section.

Next, modify the service configuration files:

  • Server: "/etc/systemd/system/pingChartsServer.service"
  • Client: "/etc/systemd/system/pingChartsClient.service" and "/etc/systemd/system/pingChartsClient.timer"