Skip to content

Commit cca42f0

Browse files
improve readme
1 parent 055412d commit cca42f0

File tree

1 file changed

+14
-19
lines changed

1 file changed

+14
-19
lines changed

README.md

Lines changed: 14 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,27 @@
11
# Remote Server for Laravel Pulse
22

3-
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.
44

55
## Installation
66

7-
Install the package using Composer:
7+
Begin by installing the package via Composer:
88

99
```shell
1010
composer require wrklst/pulse-remote-server
1111
```
1212

1313
## Authentication
1414

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.
1716

18-
## Register the recorder
17+
## Register the Recorder
1918

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:
2120

2221
```php
2322
return [
24-
// ...
25-
23+
// Other configurations...
24+
2625
'recorders' => [
2726
\WrkLst\Pulse\RemoteServer\Recorders\RemoteServers::class => [
2827
'server_name' => "database-server-1",
@@ -34,17 +33,13 @@ return [
3433
]
3534
```
3635

37-
Ensure you're running [the `pulse:check` command](https://laravel.com/docs/10.x/pulse#capturing-entries).
38-
39-
40-
And that's it!
41-
42-
## Config Notes
43-
44-
`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.
4537

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
4739

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.
4944

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.
45+
And that's all there is to it!

0 commit comments

Comments
 (0)