Installation and setup | laravel-uptime-monitor | Spatie

 SPATIE

  Laravel Uptime Monitor
=========================

spatie.be/open-source

  [Docs](https://spatie.be/docs)  [Laravel-uptime-monitor](https://spatie.be/docs/laravel-uptime-monitor/v3)  Installation and setup

 Version   v3   v2   v1

 Other versions for crawler [v3](https://spatie.be/docs/laravel-uptime-monitor/v3) [v2](https://spatie.be/docs/laravel-uptime-monitor/v2) [v1](https://spatie.be/docs/laravel-uptime-monitor/v1)

- [ Introduction ](https://spatie.be/docs/laravel-uptime-monitor/v3/introduction)
- [ Postcardware ](https://spatie.be/docs/laravel-uptime-monitor/v3/postcardware)
- [ Requirements ](https://spatie.be/docs/laravel-uptime-monitor/v3/requirements)
- [ Upgrading from a previous version ](https://spatie.be/docs/laravel-uptime-monitor/v3/upgrading-from-v2)
- [ High level overview ](https://spatie.be/docs/laravel-uptime-monitor/v3/high-level-overview)
- [ Installation and setup ](https://spatie.be/docs/laravel-uptime-monitor/v3/installation-and-setup)
- [ Questions & issues ](https://spatie.be/docs/laravel-uptime-monitor/v3/questions-and-issues)
- [ Changelog ](https://spatie.be/docs/laravel-uptime-monitor/v3/changelog)
- [ About us ](https://spatie.be/docs/laravel-uptime-monitor/v3/about-us)

Monitoring uptime
-----------------

- [ Adding and removing sites ](https://spatie.be/docs/laravel-uptime-monitor/v3/monitoring-uptime/getting-started)
- [ Events ](https://spatie.be/docs/laravel-uptime-monitor/v3/monitoring-uptime/events)
- [ Notifications ](https://spatie.be/docs/laravel-uptime-monitor/v3/monitoring-uptime/notifications)

Monitoring ssl certificates
---------------------------

- [ Getting started ](https://spatie.be/docs/laravel-uptime-monitor/v3/monitoring-ssl-certificates/getting-started)
- [ Events ](https://spatie.be/docs/laravel-uptime-monitor/v3/monitoring-ssl-certificates/events)
- [ Notifications ](https://spatie.be/docs/laravel-uptime-monitor/v3/monitoring-ssl-certificates/notifications)

Advanced usage
--------------

- [ Manually modifying monitors ](https://spatie.be/docs/laravel-uptime-monitor/v3/advanced-usage/manually-modifying-monitors)
- [ Syncing monitors from a file ](https://spatie.be/docs/laravel-uptime-monitor/v3/advanced-usage/syncing-monitors-from-a-file)
- [ Customizing the uptime check ](https://spatie.be/docs/laravel-uptime-monitor/v3/advanced-usage/customizing-the-uptime-check)
- [ Customizing notifications ](https://spatie.be/docs/laravel-uptime-monitor/v3/advanced-usage/customizing-notifications)
- [ Disabling monitors ](https://spatie.be/docs/laravel-uptime-monitor/v3/advanced-usage/disabling-monitors)
- [ Using your own model ](https://spatie.be/docs/laravel-uptime-monitor/v3/advanced-usage/using-your-own-model)
- [ Monitoring from multiple locations ](https://spatie.be/docs/laravel-uptime-monitor/v3/advanced-usage/monitoring-from-multiple-locations)
- [ Sending and verifying a payload ](https://spatie.be/docs/laravel-uptime-monitor/v3/advanced-usage/sending-and-verifying-a-payload)

 Installation and setup
======================

###  On this page

1. [ Basic installation ](#content-basic-installation)
2. [ Scheduling ](#content-scheduling)

Basic installation
--------------------------------------------------------------------------------------------------------------

This package is meant to be installed into an existing Laravel application. If you're not familiar with Laravel head over to [the official documentation](https://laravel.com/docs) to learn how to set up and use this amazing framework. If you have no interest in learning Laravel, but still want to use our uptime monitor, take a look at the [uptime-monitor-app](https://github.com/spatie/uptime-monitor-app) repo which contains a stand alone version of this package.

Standing in the directory of an existing Laravel application you can install the package via composer:

```
composer require spatie/laravel-uptime-monitor
```

The package will automatically register itself.

To publish the config file to `config/uptime-monitor.php` run:

```
php artisan vendor:publish --provider="Spatie\UptimeMonitor\UptimeMonitorServiceProvider"
```

The default contents of the configuration looks like this:

```