ZoneMinder
/
zoneminder
mirror of https://github.com/ZoneMinder/zoneminder.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Updates to Ubuntu and Debian install guides

pull/1546/head
Steve Gilvarry 2016-07-03 20:21:13 +10:00
parent 3eccdcd3e2
commit b2d1d688cc
3 changed files with 350 additions and 206 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

157
docs/installationguide/debian.rst
View File

@ -1,37 +1,154 @@
Debian
======
A fresh build based on master branch running Debian 7 (wheezy)\:
.. contents::
Easy Way: Debian Jessie
-----------------------
**Step 1**: Setup Sudo
By default Debian does not come with sudo. Log in as root or use su command.
N.B. The instructions below are for setting up sudo for your current account, you can
do this as root if you prefer.
::
aptitude update
aptitude install sudo
usermod -a -G sudo <username>
exit
Logout or try ``newgrp`` to reload user groups
**Step 2**: Run sudo and update
Now run session using sudo and ensure system is updated.
::
root@host:~# aptitude install -y apache2 mysql-server php5 php5-mysql build-essential libmysqlclient-dev libssl-dev libbz2-dev libpcre3-dev libdbi-perl libarchive-zip-perl libdate-manip-perl libdevice-serialport-perl libmime-perl libpcre3 libwww-perl libdbd-mysql-perl libsys-mmap-perl yasm automake autoconf libjpeg8-dev libjpeg8 apache2-mpm-prefork libapache2-mod-php5 php5-cli libphp-serialization-perl libgnutls-dev libjpeg8-dev libavcodec-dev libavformat-dev libswscale-dev libavutil-dev libv4l-dev libtool ffmpeg libnetpbm10-dev libavdevice-dev libmime-lite-perl dh-autoreconf dpatch;
sudo -i
aptitude safe-upgrade
root@host:~# git clone https://github.com/ZoneMinder/ZoneMinder.git zoneminder;
root@host:~# cd zoneminder;
root@host:~# ln -s distros/debian;
root@host:~# dpkg-checkbuilddeps;
root@host:~# dpkg-buildpackage;
**Step 3**: Install Apache and MySQL
These are not dependencies for the package as they could
be installed elsewhere.
One level above you'll now find a deb package matching the architecture of the build host:
::
root@host:~# ls -1 ~/zoneminder*;
/root/zoneminder_1.26.4-1_amd64.changes
/root/zoneminder_1.26.4-1_amd64.deb
/root/zoneminder_1.26.4-1.dsc
/root/zoneminder_1.26.4-1.tar.gz
aptitude install apache2 mysql-server
The dpkg command itself does not resolve dependencies. That's what high-level interfaces like aptitude and apt-get are normally for. Unfortunately, unlike RPM, there's no easy way to install a separate deb package not contained with any repository.
**Step 4**: Edit sources.list to add jessie-backports
To overcome this "limitation" we'll use dpkg only to install the zoneminder package and apt-get to fetch all needed dependencies afterwards. Running dpkg-reconfigure in the end will ensure that the setup scripts e.g. for database provisioning were executed.
::
root@host:~# dpkg -i /root/zoneminder_1.26.4-1_amd64.deb; apt-get install -f;
root@host:~# dpkg-reconfigure zoneminder;
nano /etc/apt/sources.list
Add the following to the bottom of the file
Alternatively you may also use gdebi to automatically resolve dependencies during installation:
::
root@host:~# aptitude install -y gdebi;
root@host:~# gdebi /root/zoneminder_1.26.4-1_amd64.deb;
# Backports repository
deb http://httpredir.debian.org/debian jessie-backports main contrib non-free
CTRL+o and <Enter> to save
CTRL+x to exit
**Step 5**: Install ZoneMinder
::
aptitude update
aptitude install zoneminder
**Step 6**: Read the Readme
The rest of the install process is covered in the README.Debian, so feel free to have
a read.
::
gunzip /usr/share/doc/zoneminder/README.Debian.gz
cat /usr/share/doc/zoneminder/README.Debian
**Step 7**: Setup Database
Install the zm database and setup the user account. Refer to Hints in Ubuntu install
should you choose to change default database user and password.
::
cat /usr/share/zoneminder/db/zm_create.sql | sudo mysql --defaults-file=/etc/mysql/debian.cnf
echo 'grant lock tables,alter,create,select,insert,update,delete,index on zm.* to 'zmuser'@localhost identified by "zmpass";' | sudo mysql --defaults-file=/etc/mysql/debian.cnf mysql
** Step 8**: zm.conf Permissions
Adjust permissions to the zm.conf file to allow web account to access it.
::
chgrp -c www-data /etc/zm/zm.conf
**Step 9**: Setup ZoneMinder service
::
systemctl enable zoneminder.service
**Step 10**: Configure Apache
The following commands will setup the default /zm virtual directory and configure
required apache modules.
::
a2enconf zoneminder
a2enmod cgi
a2enmod rewrite
**Step 11**: Edit Timezone in PHP
::
nano /etc/php5/apache2/php.ini
Search for [Date] (Ctrl + w then type Date and press Enter) and change
date.timezone for your time zone. **Don't forget to remove the ; from in front
of date.timezone**
::
[Date]
; Defines the default timezone used by the date functions
; http://php.net/date.timezone
date.timezone = America/New_York
CTRL+o then [Enter] to save
CTRL+x to exit
**Step 12**: Start ZoneMinder
Reload Apache to enable your changes and then start ZoneMinder.
::
service apache2 reload
service zoneminder start
**Step 13**: Making sure ZoneMinder works
1. Open up a browser and go to ``http://hostname_or_ip/zm`` - should bring up ZoneMinder Console
2. (Optional API Check)Open up a tab in the same browser and go to ``http://hostname_or_ip/zm/api/host/getVersion.json``
If it is working correctly you should get version information similar to the example below:
::
{
"version": "1.29.0",
"apiversion": "1.29.0.1"
}
**Congratulations** Your installation is complete

398
docs/installationguide/ubuntu.rst
View File

@ -1,227 +1,227 @@
Ubuntu Instruction
===================
Ubuntu
======
.. contents::
Easy Way: Install ZoneMinder from a package (Ubuntu 15.x+)
-----------------------------------------------------------
These instructions are for a brand new ubuntu 15.04 system which does not have ZM installed.
Easy Way: Ubuntu 16.04
----------------------
These instructions are for a brand new ubuntu 16.04 system which does not have ZM
installed.
**Step 1**: Make sure we add the correct packages
It is recommended that you use an Ubuntu Server install and select the LAMP option
during install to install Apache, MySQL and PHP. If you failed to do this you can
achieve the same result by running:
::
tasksel install lamp-server
During installation it will ask you to set up a master/root password for the MySQL.
**Step 1**: Either run commands in this install using sudo or use the below to become root
::
sudo -i
**Step 2**: Update Repos
.. topic :: Latest Release
ZoneMinder 1.29.0 is now part of the current standard Ubuntu repository. But
if you wish to install the later releases of ZoneMinder you will need
to add the iconnor/zoneminder PPA.
::
add-apt-repository ppa:iconnor/zoneminder
Update repo and upgrade.
::
apt-get update
apt-get upgrade
apt-get dist-upgrade
**Step 3**: Configure MySQL
.. sidebar :: Note
The MySQL default configuration file (/etc/mysql/mysql.cnf)is read through
several symbolic links beginning with /etc/mysql/my.cnf as follows:
| /etc/mysql/my.cnf -> /etc/alternatives/my.cnf
| /etc/alternatives/my.cnf -> /etc/mysql/mysql.cnf
| /etc/mysql/mysql.cnf is a basic file
Certain new defaults in MySQL 5.7 are currently causing some issues with ZoneMinder,
the workaround is to modify the sql_mode setting of MySQL.
To better manage the MySQL server it is recommended to copy the sample config file and
replace the default my.cnf symbolic link.
::
rm /etc/mysql/my.cnf (this removes the current symbolic link)
cp /etc/mysql/mysql.conf.d/mysqld.cnf /etc/mysql/my.cnf
To change MySQL settings:
::
nano /etc/mysql/my.cnf
In the [mysqld] section add the following
::
sql_mode = NO_ENGINE_SUBSTITUTION
CTRL+o then [Enter] to save
CTRL+x to exit
Restart MySQL
::
systemctl restart mysql
**Step 4**: Install ZoneMinder
::
sudo add-apt-repository ppa:iconnor/zoneminder
sudo apt-get update
apt-get install zoneminder
if you don't have mysql already installed:
**Step 5**: Configure the ZoneMinder Database
::
sudo apt-get install mysql-server
This will ask you to set up a master password for the DB (you are asked for the mysql root password when installing mysql server).
**Step 2**: Install ZoneMinder
::
sudo apt-get install zoneminder
**Step 3**: Configure the Database
::
sudo mysql -uroot -p < /usr/share/zoneminder/db/zm_create.sql
mysql -uroot -p < /usr/share/zoneminder/db/zm_create.sql
mysql -uroot -p -e "grant select,insert,update,delete,create,alter,index,lock tables on zm.* to 'zmuser'@localhost identified by 'zmpass';"
You don't really need this, but no harm (needed if you are upgrading)
**Step 6**: Set permissions
Set /etc/zm/zm.conf to root:www-data 740 and www-data access to content
::
sudo /usr/bin/zmupdate.pl
chmod 740 /etc/zm/zm.conf
chown root:www-data /etc/zm/zm.conf
chown -R www-data:www-data /usr/share/zoneminder/
**Step 4**: Configure systemd to recognize ZoneMinder and configure Apache correctly:
**Step 7**: Configure Apache correctly:
::
sudo systemctl enable zoneminder
sudo a2enconf zoneminder
sudo a2enmod cgi
sudo chown -R www-data:www-data /usr/share/zoneminder/
a2enconf zoneminder
a2enmod cgi
a2enmod rewrite
We need this for API routing to work:
**Step 8**: Enable and start Zoneminder
::
sudo a2enmod rewrite
systemctl enable zoneminder
service zoneminder start
This is probably a bug with iconnor's PPA as of Oct 3, 2015 with package 1.28.107. After installing, ``zm.conf`` does not have the right read permissions, so we need to fix that. This may go away in future PPA releases:
**Step 9**: Edit Timezone in PHP
::
sudo chown www-data:www-data /etc/zm/zm.conf
nano /etc/php/7.0/apache2/php.ini
We also need to install php5-gd (as of 1.28.107, this is not installed)
Search for [Date] (Ctrl + w then type Date and press Enter) and change
date.timezone for your time zone. **Don't forget to remove the ; from in front
of date.timezone**
::
sudo apt-get install php5-gd
[Date]
; Defines the default timezone used by the date functions
; http://php.net/date.timezone
date.timezone = America/New_York
**Step 5**: Edit Timezone in PHP
CTRL+o then [Enter] to save
CTRL+x to exit
**Step 10**: Restart Apache service
::
vi /etc/php5/apache2/php.ini
service apache2 reload
Look for [Date] and inside it you will see a date.timezone
that is commented. remove the comment and specific your timezone.
Please make sure the timezone is valid (see this: http://php.net/manual/en/timezones.php)
**Step 11**: Making sure ZoneMinder works
In my case:
1. Open up a browser and go to ``http://hostname_or_ip/zm`` - should bring up ZoneMinder Console
::
2. (Optional API Check)Open up a tab in the same browser and go to ``http://hostname_or_ip/zm/api/host/getVersion.json``
date.timezone = America/New_York
If it is working correctly you should get version information similar to the example below:
**Step 6**: Restart services
::
::
{
"version": "1.29.0",
"apiversion": "1.29.0.1"
}
sudo service apache2 reload
sudo systemctl restart zoneminder
**Congratulations** Your installation is complete
PPA install may need some tweaking of ZMS_PATH in ZoneMinder options. `Socket_sendto or no live streaming`_
**Step 7: make sure live streaming works**: Make sure you can view Monitor streams:
startup ZM console in your browser, go to ``Options->Path`` and make sure ``PATH_ZMS`` is set to ``/zm/cgi-bin/nph-zms`` and restart ZM (you should not need to do this for packages, as this should automatically work)
**Step 8**: If you have changed your DB login/password from zmuser/zmpass, the API won't know about it
If you changed the DB password **after** installing ZM, the APIs will not be able to connect to the DB.
If you have, go to ``zoneminder/www/api/app/Config`` & Edit ``database.php``
There is a class there called ``DATABASE_CONFIG`` - change the ``$default`` array to reflect your new details. Example:
::
public $default = array(
'datasource' => 'Database/Mysql',
'persistent' => false,
'host' => 'localhost',
'login' => 'mynewDBusername',
'password' => 'mynewDBpassword'
'database' => 'zm',
'prefix' => '',
//'encoding' => 'utf8',
);
You are done. Lets proceed to make sure everything works:
Making sure ZM and APIs work:
1. open up a browser and go to ``http://localhost/zm`` - should bring up ZM
2. (OPTIONAL - just for peace of mind) open up a tab and go to ``http://localhost/zm/api`` - should bring up a screen showing CakePHP version with some green color boxes. Green is good. If you see red, or you don't see green, there may be a problem (should not happen). Ignore any warnings in yellow saying "DebugKit" not installed. You don't need it
3. open up a tab in the same browser and go to ``http://localhost/zm/api/host/getVersion.json``
If it responds with something like:
::
{
"version": "1.28.107",
"apiversion": "1.28.107.1"
}
**Then your APIs are working**
Make sure ZM and APIs work with security:
1. Enable OPT_AUTH in ZM
2. Log out of ZM in browser
3. Open a NEW tab in the SAME BROWSER (important) and go to ``http://localhost/zm/api/host/getVersion.json`` - should give you "Unauthorized" along with a lot more of text
4. Go to another tab in the SAME BROWSER (important) and log into ZM
5. Repeat step 3 and it should give you the ZM and API version
**Congrats** your installation is complete
Easy Way: Install ZoneMinder from a package (Ubuntu 14.x)
Easy Way: Ubuntu 14.x
-----------------------------------------------------------
**These instructions are for a brand new ubuntu 14.x system which does not have ZM installed.**
**Step 1:** Install ZoneMinder
**Step 1**: Either run commands in this install using sudo or use the below to become root
::
sudo -i
**Step 2:** Install ZoneMinder
::
sudo add-apt-repository ppa:iconnor/zoneminder
sudo apt-get update
sudo apt-get install zoneminder
add-apt-repository ppa:iconnor/zoneminder
apt-get update
apt-get install zoneminder
(just press OK for the prompts you get)
**Step 2:** Set up DB
**Step 3:** Set up DB
::
sudo mysql -uroot -p < /usr/share/zoneminder/db/zm_create.sql
mysql -uroot -p < /usr/share/zoneminder/db/zm_create.sql
mysql -uroot -p -e "grant select,insert,update,delete,create,alter,index,lock tables on zm.* to 'zmuser'@localhost identified by 'zmpass';"
**Step 3:** Set up Apache
**Step 4:** Set up Apache
::
sudo a2enconf zoneminder
sudo a2enmod rewrite
sudo a2enmod cgi
a2enconf zoneminder
a2enmod rewrite
a2enmod cgi
**Step 4:**:Some tweaks that will be needed:
**Step 5:**:Some tweaks that will be needed:
Edit ``/etc/init.d/zoneminder``:
add a ``sleep 10`` right after line 25 that reads ``echo -n "Starting $prog:"``
(The reason we need this sleep is to make sure ZM starts after mysqld starts)
As of Oct 3 2015, zm.conf is not readable by ZM. This is likely a bug and will go away in the next package
Make zm.conf readable by web user.
::
sudo chown www-data:www-data /etc/zm/zm.conf
**Step 5**: If you have changed your DB login/password
If you changed the DB password **after** installing ZM, the APIs will not be able to connect to the DB.
If you have, go to ``/usr/share/zoneminder/www/api/app/Config`` & Edit ``database.php``
There is a class there called ``DATABASE_CONFIG`` - change the ``$default`` array to reflect your new details. Example:
::
public $default = array(
'datasource' => 'Database/Mysql',
'persistent' => false,
'host' => 'localhost',
'login' => 'mynewDBusername',
'password' => 'mynewDBpassword'
'database' => 'zm',
'prefix' => '',
//'encoding' => 'utf8',`
);
We also need to install php5-gd (as of 1.28.107, this is not installed)
::
sudo apt-get install php5-gd
**Step 6**: Edit Timezone in PHP
``sudo vi /etc/php5/apache2/php.ini``
@ -236,54 +236,31 @@ In my case:
date.timezone = America/New_York
**Step 7: make sure live streaming works**: Make sure you can view Monitor streams:
startup ZM console in your browser, go to ``Options->Path`` and make sure ``PATH_ZMS`` is set to ``/zm/cgi-bin/nph-zms`` and restart ZM (you should not need to do this for packages, as this should automatically work)
restart:
**Step 7**: Restart Apache service
::
sudo service apache2 restart
sudo service zoneminder restart
service apache2 reload
**Step 8**: Making sure ZM and APIs work: (optional - only if you need APIs)
**Step 8**: Making sure ZoneMinder works
1. open up a browser and go to ``http://localhost/zm`` - should bring up ZM
2. (OPTIONAL - just for peace of mind) open up a tab and go to ``http://localhost/zm/api`` - should bring up a screen showing CakePHP version with some green color boxes. Green is good. If you see red, or you don't see green, there may be a problem (should not happen). Ignore any warnings in yellow saying "DebugKit" not installed. You don't need it
3. open up a tab in the same browser and go to ``http://localhost/zm/api/host/getVersion.json``
1. Open up a browser and go to ``http://hostname_or_ip/zm`` - should bring up ZoneMinder Console
If it responds with something like:
2. (Optional API Check)Open up a tab in the same browser and go to ``http://hostname_or_ip/zm/api/host/getVersion.json``
::
{
"version": "1.28.107",
"apiversion": "1.28.107.1"
}
Then your APIs are working
Make sure you can view Monitor View:
1. Open up ZM, configure your monitors and verify you can view Monitor feeds.
2. If not, open up ZM console in your browser, go to ``Options->Path`` and make sure ``PATH_ZMS`` is set to ``/zm/cgi-bin/nph-zms`` and restart ZM (you should not need to do this for packages, as this should automatically work)
Make sure ZM and APIs work with security:
1. Enable OPT_AUTH in ZM
2. Log out of ZM in browser
3. Open a NEW tab in the SAME BROWSER (important) and go to ``http://localhost/zm/api/host/getVersion.json`` - should give you "Unauthorized" along with a lot more of text
4. Go to another tab in the SAME BROWSER (important) and log into ZM
5. Repeat step 3 and it should give you the ZM and API version
**Congrats** Your installation is complete
If it is working correctly you should get version information similar to the example below:
::
{
"version": "1.29.0",
"apiversion": "1.29.0.1"
}
**Congratulations** Your installation is complete
Harder Way: Build Package From Source
-------------------------------------------
-------------------------------------
(These instructions assume installation from source on a ubuntu 15.x+ system)
**Step 1:** Grab the package installer script
@ -388,4 +365,53 @@ open up ZM console in your browser, go to Options->Path and make sure ``PATH_ZMS
* point your browser to http://yourzmip/zm/api/host/getVersion.json - you should see an API version
* Configure your monitors and make sure its all a-ok
Hints
-----
Make sure ZoneMinder and APIs work with security
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1. Enable OPT_AUTH in ZoneMinder
2. Log out of ZoneMinder in browser
3. Open a new tab in the *same browser* (important) and go to ``http://localhost/zm/api/host/getVersion.json`` - should give you "Unauthorized" along with a lot more of text
4. Go to another tab in the SAME BROWSER (important) and log into ZM
5. Repeat step 3 and it should give you the ZM and API version
Socket_sendto or no live streaming
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
After you have setup your camera make sure you can view Monitor streams, if not
check some of the common causes:
* Check Apache cgi module is enabled.
* Check Apache /etc/apache2/conf-enabled/zoneminder.conf ScriptAlias matches PATH_ZMS.
ScriptAlias **/zm/cgi-bin** /usr/lib/zoneminder/cgi-bin
From console go to ``Options->Path`` and make sure PATH_ZMS is set to **/zm/cgi-bin/**\ nph-zms.
Changed Default DB User
^^^^^^^^^^^^^^^^^^^^^^^
If you have changed your DB login/password from zmuser/zmpass, you need to
update these values in zm.conf and the API's database.php file.
1. Edit zm.conf to change ZM_DB_USER and ZM_DB_PASS to the values you used.
2. Edit databse.php which can be found in the web server folder zoneminder/www/api/app/Config
There is a class there called DATABASE_CONFIG -
change the $default array to reflect your new details. Example:
::
public $default = array(
'datasource' => 'Database/Mysql',
'persistent' => false,
'host' => 'localhost',
'login' => 'mynewDBusername',
'password' => 'mynewDBpassword'
'database' => 'zm',
'prefix' => '',
//'encoding' => 'utf8',
);

1
docs/userguide/options.rst
View File

@ -10,6 +10,7 @@ If you have changed the value of an option you should then ‘save’ it. A numb
options/options_display
options/options_system
options/options_config
options/options_servers
options/options_paths
options/options_web
options/options_images