` Uppity 2 Documentation - Everything you need to get started!

What is this?

Uppity is an application that provides real-time monitoring of websites & servers with email and SMS alert options.

There are times when you need to monitor a web site, specific web page, or an entire server to make sure it's online when it's needed most. While you could simply try and connect to the server yourself every so often or even wait until someone tells you its gone down, why not be pro-active and automate this task.

This makes it simpler for everyone involved and know when something has gone down, also with loggin you gain the abaility to keep a record of up and down times.


Features

Uppity 2 Web Monitor Features:

  • Easy to use web installer.
  • Monitor unlimited sites or servers.
  • Different connection types.
  • Email alerts.
  • SMS alerts.
  • Multi-user system.
  • Admin user management.
  • Database and flat file logging.
  • Automated configuration file builder.
  • Ability to monitor specific web pages.
  • HTTP Status codes.
  • Timed Response logs.
  • And more...

It also allows for users to customize their email alert template as well as the SMS message sent when a monitored site or server goes down.


Prerequisites

First up thank you for checking out Uppity 2! It's very awesome of you and I really appreciate it. Now let's get down to business and get this script installed.

There are a few requirements that your system must meet in order to use Uppity 2. Please check the list below to make sure you meet them.

  • PHP >= 7.1.3
  • OpenSSL PHP Extension
  • PDO PHP Extension
  • Mbstring PHP Extension
  • Tokenizer PHP Extension
  • XML PHP Extension
  • Ctype PHP Extension
  • JSON PHP Extension

Get Started

Installation Video

We also provide you with a quick and easy installation video it bascially covers what's outlined in this document.

First thing we need to do is upload all of the files provided in the uppity2 folder to your desired location. After we have that make sure the following directories have write permissions:

  • storage/framework
  • storage/framework/cache
  • storage/framework/sessions
  • storage/framework/views
  • storage/logs
  • storage/install
  • storage/install/tmp
  • bootstrap/cache
  • database/migrations

Uppity 2 provides users with a web based installer to make setup quick and simple. Making sure we have our permissions set we should be ready to install!

Direct your web brower to your fresh install http://yoursite.com/install and you should be present with the Uppity 2 installer. From here on out make sure to follow the on-screen instructions.


Configuration

After filling out all the relevant information you should be ready to put your .env file in place. We'll go over the .env file and some of it's options below. For the most part these should be set by the application already however you may want to tweak these settings.

Options Value Default
APP_ENV Current enviroment we are running on this should stay on "production" unless you are editing / debugging the site. then "local" is suggested. production
APP_DEBUG Enable or disable debugging this should be turned off on production sites. false
APP_URL This should be the complete url to your website without the trailing slash. http://yoursite.com

Database

Also in the .env file you will find the database settings outlined below.

Options Value Default
DB_CONNECTION The database type you wish to use. mysql
DB_HOST Host of the database. 127.0.0.1
DB_PORT The port the database is listening on. 3306
DB_DATABASE The name of the database we are to use. uppity2
DB_USERNAME Username for database access.
DB_PASSWORD Password for database access.

Mail Settings

Also in the .env file you will find your mail server settings outlined below.

Options Value Default
MAIL_DRIVER The mail driver we want to use. smtp
MAIL_HOST Your mail server address.
MAIL_PORT The port to your mail server. 25
MAIL_USERNAME Mail server username.
MAIL_PASSWORD Mail server password..
MAIL_ENCRYPTION Encryption your mail server uses, if any.

Nexmo SMS Settings

Lastly as also have Nexmo SMS settings. These are required if you plan on using our SMS feature.

Options Value Default
NEXMO_KEY Your Nexmo API Key.
NEXMO_SECRET Your Nexmo API Secret.
NEXMO_FROM The from number on your Nexmo account. 25

Example .env File

Here is and example .env file for a site called http://yoursite.com/uppity

                        
                            APP_NAME=Uppity2
                            APP_ENV=production
                            APP_KEY=base64:P5oSUaGxz+P0DNeXTSjJwjziWmNWhI644YQA9hOcQ28=
                            APP_DEBUG=true
                            APP_URL=http://yoursite.com/uppity2

                            LOG_CHANNEL=stack

                            BROADCAST_DRIVER=log
                            CACHE_DRIVER=file
                            QUEUE_CONNECTION=sync
                            SESSION_DRIVER=file
                            SESSION_LIFETIME=120

                            DB_CONNECTION=mysql
                            DB_HOST=localhost
                            DB_PORT=3306
                            DB_DATABASE=uppity2
                            DB_USERNAME=root
                            DB_PASSWORD=secret

                            MAIL_DRIVER=smtp
                            MAIL_HOST=smtp.mailtrap.io
                            MAIL_PORT=2525
                            MAIL_USERNAME=mailtrap_user
                            MAIL_PASSWORD=mailtrap_password
                            MAIL_ENCRYPTION=

                            NEXMO_KEY=5555555b
                            NEXMO_SECRET=222222222b341010
                            NEXMO_FROM=16045554202
                        
                    

Post Installation

After you have successfully installed Uppity 2 the default email / password to your new site is email: admin@uppity.com password: uppity2 you MUST (I really can't stress that enough) change it right away.

To change this simply login to your Uppity 2 system and click the "Admin" menu link in the top right. In the dropdown menu that appears select "Manage Users" and then you will be taken to a list of all current users (there should only be 1 user at this point). Click the pencil icon and change your email address and password to anything you like. Click save and voilĂ !

At this point you're ready to start using Uppity 2. Enjoy.


Cron Setup

Last on the list of things to do! We need to setup cron to check our sites at the correct intervals. The way to do this depends on your system and how you access it. For most *nix based systems you can ssh into your system as the uppity user and run the follwing command crontab -e

However some users who are running plesk or another system management tool will have differnet ways to access their cron schedual, please make sure to check with your provider on how to go about doing this.

Here are the cron entries you will need to add making sure you replace /replace/with/your/path/uppity/ with the full path to your Uppity 2 root folder.

                        
                            */5 * * * *  php /replace/with/your/path/uppity/artisan sites:check 300 >/dev/null 2>&1
                            */30 * * * * php /replace/with/your/path/uppity/artisan sites:check 1800 >/dev/null 2>&1
                            0 * * * *    php /replace/with/your/path/uppity/artisan sites:check 3600 >/dev/null 2>&1
                            0 */12 * * * php /replace/with/your/path/uppity/artisan sites:check 43200 >/dev/null 2>&1
                            0 0 * * *    php /replace/with/your/path/uppity/artisan sites:check 86400 >/dev/null 2>&1
                        
                    

Optional If you would like to auto clear all users logs you can add an additional cron job. The example below would clear all users logs on the 1st day of every month.

                        
                            0 0 1 * * php /replace/with/your/path/uppity/artisan prune:logs >/dev/null 2>&1
                        
                    

Upgrading

If this is an upgrade, simply follow the steps below.

  1. First backup your existing database and your current existing Uppity2 install.
  2. Once that's finished simply upload and overwrite all the files in the uppity2 folder.
  3. After the upload has finished point your browser to: http://yoursite.com/uppity2/upgrade to run any database changes.

That's it, your upgrade is finished.

Support

Check your logs: First up make sure to check your logs, log files can be found in the storage/logs folder and this should be the first place you look for and error message.

Envato: If you have purchased Uppity 2 feel free to post a question on the CodeCanyon Uppity 2 comments section.

Discord: I also offer up my help on Discord whenever I have time. You can join my Discord server here: https://discord.gg/TcWJJGJ