|
1 | 1 | # Watchtower |
2 | | -Self-hosted application and server monitoring for Laravel. |
| 2 | +Watchtower is monitoring software for Laravel and your VPS. |
3 | 3 |
|
4 | | -Watchtower notifies you if any of your Laravel applications: |
5 | | -- Have error logs |
6 | | -- Have failed jobs |
7 | | -- Have queue workers that are stuck or not running |
| 4 | +Watchtower will: |
| 5 | +- Send you an alert if your Laravel application has new logs |
| 6 | +- Send you an alert if any of your Supervisor processes (queue workers) are not running |
| 7 | +- Send you an alert if your server is running out of disk space (coming soon) |
| 8 | +- Send you an alert if your server is offline (coming soon) |
8 | 9 |
|
9 | | -Watchtower also notifies your if your server: |
10 | | -- Is running low on disk space |
| 10 | +## Learn more |
| 11 | +Visit https://watchtower.dev/about to learn more about Watchtower. |
11 | 12 |
|
12 | | -# Getting Started |
13 | | -Watchtower consists of two parts: |
14 | | -- Watchtower: a standard Laravel application that receives and shows data from the client |
15 | | -- The Watchtower client: a bash script that sends data to Watchtower every minute via the cron |
16 | | - |
17 | | -### Installing Watchtower |
18 | | -Watchtower is a standard Laravel application, host it as you would any other Laravel application. |
19 | | -Once you have Watchtower running, run the following command: |
20 | | -``` |
21 | | -php artisan watchtower:install |
22 | | -``` |
23 | | - |
24 | | -### Installing the client |
25 | | -The client is a bash script that collects data on your server. |
26 | | -No changes are required to any of your applications, you just have to download the client and add it to the cron. |
27 | | - |
28 | | -To install the client, run the following command on your server: |
29 | | -``` |
30 | | -cd ~ && bash wget (...install.sh) |
31 | | -``` |
32 | | - |
33 | | -The installation script will download the latest version of the client and help you configure which applications should be monitored. |
34 | | - |
35 | | -Now add a cron entry that runs the client: |
36 | | -``` |
37 | | -* * * * * cd ~/watchtower-client && bash run.sh >> /dev/null 2>&1 |
38 | | -``` |
39 | | - |
40 | | -As soon as the cron runs you'll see the applications you've configured appear in Watchtower. |
41 | | - |
42 | | -# Development |
43 | | -To run the project and tests locally, create two databases: `LOCAL_watchtower` and `TEST_LOCAL_watchtower`. |
| 13 | +## License |
| 14 | +Watchtower is open-sourced software licensed under the MIT license. |
0 commit comments