You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Add remote linux server to your server stats. This is meant for servers that do not run PHP, e.g. database or cache servers. Servers that run PHP should install their own instance of [Laravel Pulse](https://pulse.laravel.com) instead.
3
+
Enhance your server stats by adding a remote Linux server to the mix. This feature is designed to incorporate remote servers to Laravel Pulse that do not execute PHP, such as database or cache servers. Servers running PHP are recommended to install their own instance of [Laravel Pulse](https://pulse.laravel.com) instead.
4
4
5
5
## Installation
6
6
7
-
Install the package using Composer:
7
+
Begin by installing the package via Composer:
8
8
9
9
```shell
10
10
composer require wrklst/pulse-remote-server
11
11
```
12
12
13
13
## Authentication
14
14
15
-
Requires SSH key authentication in place for authentication to remote server.
16
-
Remote Server is assumed to be running Linux. Local server supports Mac and Linux servers.
15
+
Ensure SSH key authentication is set up for accessing the remote server. The Remote Server package assumes the remote server is running Linux. It is compatible with both Mac and Linux servers for in your Larvel Pulse installation.
17
16
18
-
## Register the recorder
17
+
## Register the Recorder
19
18
20
-
In your `pulse.php` configuration file, register the \WrkLst\Pulse\RemoteServer\Recorders\RemoteServers with the desired settings:
19
+
In your `pulse.php` configuration file, incorporate the `\WrkLst\Pulse\RemoteServer\Recorders\RemoteServers` class with the desired settings:
`server_name`: name of server how it should be shown in the server stats
36
+
Don't forget to run [the `pulse:check` command](https://laravel.com/docs/10.x/pulse#capturing-entries) to start recording.
45
37
46
-
`server_ssh`: ssh command to connect to server (ssh user@ipaddress, can also inlcude option -p 2222 for the port if you are not using standard ports etc).
38
+
## Configuration Notes
47
39
48
-
`query_interval`: define the interval of how often the stats should be queries in seconds
40
+
-`server_name`: Specify the name of the server as it should appear in the server stats.
41
+
-`server_ssh`: Enter the SSH command to connect to the server (`ssh user@ipaddress`). You can also include options like `-p 2222` for non-standard ports.
42
+
-`query_interval`: Define the interval for querying the remote server's stats, in seconds.
43
+
-`directories`: Specify the directories to check for used and available disk capacity. By default, this is set to "/", but you can add multiple directories or change the directory. Note that altering this configuration might impact query performance. For specialized setups, consider forking the repository and adjusting the shell script accordingly.
49
44
50
-
`directories`: define the directories checked for disk capacity used and available. We recommend keeping this at "/". adding multiple directories or changing the directory will slow down the query. If you have a special setup, considder forking the repository and adjusting the shell script accordginly.
0 commit comments