diff --git a/docs/faq.rst b/docs/faq.rst index a84d4efb..efcaee55 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -25,6 +25,37 @@ Regular users: * Run the updater on their assigned servers. +Servers ++++++++ + +What is the difference between a service and a website? +------------------------------------------------------- + +For websites, the monitor attempts to open a regular web page, just like you do in your browser. +It will attempt to retrieve its contents, and also check the HTTP status code (for example "404 not found" will cause an error). +You can then even add a check to make sure the content of the website includes a certain string or matches a certain regular expression. +Please note, it only retrieves the contents and does not execute any Javascript. Your search pattern will not work if it depends on Javascript being executed. + +For services, the monitor only attempts to connect to the IP address and specified port to check whether the server is listening on that port. +For example, if you are running a webserver it will usually listen on port 80 for incoming connections. +So if the monitor is able to connect to the server on port 80, you know the webserver is running and accepting connections. +It does not, however, mean that your website is available to your users, because it might have PHP errors or database problems. +This can be monitored using the website type with a pattern search as described above. + +Are requests made by the monitor included in my website statistics? +------------------------------------------------------------------- + +There are two different ways to gather statistics. +One way is to include a piece of Javascript in your HTML, e.g. for Google Analytics and Piwik. +The other way is to parse the access logs created by your webserver software, which does not require any changes to your code, and is done by tools like Awstats. + +When using tools such as Google Analytics, the monitor requests will not show up in your statistics, because the monitor does not execute any Javascript. +Tools that parse your raw access logs like Awstats, will include the requests made by the monitor. +To make sure these requests can be identified, the monitor uses a custom user agent, which you can usually filter out. The user agent of the monitor looks like:: + +Mozilla/5.0 (compatible; phpservermon/3.0.1; +http://www.phpservermonitor.org) + + Configuration +++++++++++++