diff --git a/5_release_notes.md b/5_release_notes.md index 0dc3da3..5892d3c 100644 --- a/5_release_notes.md +++ b/5_release_notes.md @@ -23,18 +23,21 @@ #### Web -* Upgrade from Laravel 4.2 to Laravel 5.4. -* Fix bug with heatmap radius slider. +* Upgrade from Laravel 4.2 to Laravel 5.4 [#70](https://github.com/kerberos-io/web/issues/70). +* Fix bug with heatmap radius slider [#84](https://github.com/kerberos-io/web/issues/84). * Design tweaks toggle button (remove outline). +* Disabled possibility to timestamp video when using hardware acceleration. #### Docker -* Fix SSL support. +* Fix SSL support [#4](https://github.com/kerberos-io/docker/issues/4). #### Machinery -* OpenMAX IL hardware encoding for Raspberry Pi camera (benchmark 30FPS on Raspberry Pi Zero W). -* Basic authentication for live stream. +* OpenMAX IL hardware encoding for Raspberry Pi camera. [#83](https://github.com/kerberos-io/machinery/issues/83) + * Optimized live streaming (benchmark 30FPS on Raspberry Pi Zero W). + * Optimized h264 recording (benchmark 30FPS on Raspberry Pi Zero W) +* Basic authentication for live streaming (username and password). [#80](https://github.com/kerberos-io/machinery/issues/80) ## 2.3.1 diff --git a/70_installation/3_Raspbian.md b/70_installation/3_Raspbian.md index 5d3880a..6c61616 100644 --- a/70_installation/3_Raspbian.md +++ b/70_installation/3_Raspbian.md @@ -20,7 +20,7 @@ A short video explaining how to install Kerberos.io on Raspbian. ## Machinery -###Install package +###Install package Update system @@ -30,10 +30,10 @@ Download the debian file from [**the machinery repository**](https://github.com/ sudo wget https://github.com/kerberos-io/machinery/releases/download/v%machineryversion%/rpiX-machinery-kerberosio-armhf-%machineryversion%.deb -Unpackage the file +Unpackage the file sudo dpkg -i rpiX-machinery-kerberosio-armhf-%machineryversion%.deb - + Enable Raspberry Pi camera (if needed) sudo raspi-config @@ -41,7 +41,7 @@ Enable Raspberry Pi camera (if needed) Start the machinery on start-up, and reboot the system. sudo systemctl enable kerberosio && sudo reboot - + ###Configure @@ -61,20 +61,21 @@ After kerberos is installed a binary is available at **/usr/bin/kerberosio**. Ju ### Install Nginx + PHP Before you can run the web interface, you'll need to download and configure a webserver. Kerberos.io recommends to use Nginx, as it is a light-weight and fast webserver. The web interface is written in PHP, so we also need to download PHP and some packages. - + Update the packages and kernel. + echo "deb http://mirrordirector.raspbian.org/raspbian/ stretch main contrib non-free rpi" | sudo tee --append /etc/apt/sources.list sudo apt-get update && sudo apt-get upgrade Install Nginx and PHP (+extension). - sudo apt-get install nginx php5-cli php5-fpm php5-gd php5-mcrypt php5-curl + sudo apt-get install -t stretch nginx php7.0 php7.0-curl php7.0-gd php7.0-fpm php7.0-cli php7.0-opcache php7.0-mbstring php7.0-xml php7.0-zip php7.0-mcrypt Creating a Nginx config. sudo rm -f /etc/nginx/sites-enabled/default - sudo nano /etc/nginx/sites-enabled/default - + sudo nano /etc/nginx/sites-enabled/default + Copy and paste following config file; this file tells nginx where the web will be installed and that it requires PHP. server @@ -96,12 +97,12 @@ Copy and paste following config file; this file tells nginx where the web will b location ~ \.php$ { - fastcgi_pass unix:/var/run/php5-fpm.sock; + fastcgi_pass unix:/var/run/php/php7.0-fpm.sock; fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name; include fastcgi_params; } } - + Restart nginx and reboot system sudo service nginx restart && sudo reboot @@ -110,7 +111,7 @@ Restart nginx and reboot system ### Install source Create a www location. - + sudo mkdir -p /var/www/web && cd /var/www/web Get the source code from Github. @@ -121,7 +122,12 @@ Unpack sudo tar xvf web.tar.gz . -Add write permission for the storage directory, and the kerberos config file. +Change write permission on the storage directory. - sudo chmod -R 777 app/storage - sudo chmod 777 app/config/kerberos.php \ No newline at end of file + sudo chmod -R 777 storage + sudo chmod -R 777 bootstrap/cache + sudo chmod 777 config/kerberos.php + +Reboot + + sudo reboot diff --git a/70_installation/4_Armbian.md b/70_installation/4_Armbian.md index 254dcd1..6f88178 100644 --- a/70_installation/4_Armbian.md +++ b/70_installation/4_Armbian.md @@ -14,7 +14,7 @@ ## Machinery -###Install package +###Install package Update system and install dependency avcodec. These installation instructions assume that a fresh Armbian 5.24 or 5.25 installed. @@ -24,14 +24,14 @@ Download the debian file from [**the machinery repository**](https://github.com/ sudo wget https://github.com/kerberos-io/machinery/releases/download/v%machineryversion%/armbian-machinery-kerberosio-armhf-%machineryversion%.deb -Unpackage the file +Unpackage the file sudo dpkg -i armbian-machinery-kerberosio-armhf-%machineryversion%.deb Start the machinery on start-up, and reboot the system. sudo systemctl enable kerberosio && sudo reboot - + ###Configure @@ -53,20 +53,20 @@ In case kerberosio does not start and complains about missing libraries, install ### Install webserver + PHP (optional) - + Update the packages and kernel. sudo apt-get update && sudo apt-get upgrade Install Nginx and PHP (+extension). - sudo apt-get install nginx php5-cli php5-fpm php5-gd php5-mcrypt php5-curl + sudo apt-get install nginx php7.0 php7.0-curl php7.0-gd php7.0-fpm php7.0-cli php7.0-opcache php7.0-mbstring php7.0-xml php7.0-zip php7.0-mcrypt nodejs npm Creating a Nginx config. sudo rm -f /etc/nginx/sites-enabled/default - sudo nano /etc/nginx/sites-enabled/default - + sudo nano /etc/nginx/sites-enabled/default + Copy and paste following config file; this file tells nginx where the web will be installed and that it requires PHP. server @@ -88,12 +88,12 @@ Copy and paste following config file; this file tells nginx where the web will b location ~ \.php$ { - fastcgi_pass unix:/var/run/php5-fpm.sock; + fastcgi_pass unix:/var/run/php/php7.0-fpm.sock; fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name; include fastcgi_params; } } - + Restart nginx and reboot system sudo service nginx restart && sudo reboot @@ -102,7 +102,7 @@ Restart nginx and reboot system ### Install source Create a www location. - + sudo mkdir -p /var/www/web && cd /var/www/web Get the source code from Github. @@ -115,5 +115,10 @@ Unpack Change write permission on the storage directory. - sudo chmod -R 777 app/storage - sudo chmod 777 app/config/kerberos.php \ No newline at end of file + sudo chmod -R 777 storage + sudo chmod -R 777 bootstrap/cache + sudo chmod 777 config/kerberos.php + +Reboot + + sudo reboot diff --git a/70_installation/4_Docker.md b/70_installation/4_Docker.md index fb85105..273b905 100644 --- a/70_installation/4_Docker.md +++ b/70_installation/4_Docker.md @@ -15,6 +15,8 @@ Create a **docker-compose.yml** file and following configuration: web: image: kerberos/web + environment: + - KERBEROSIO_SECURE_SSL=false ports: - "80" volumes_from: @@ -24,4 +26,4 @@ Create a **docker-compose.yml** file and following configuration: Run following command; this will download the Kerberos.io docker images and configure them properly. - docker-compose up \ No newline at end of file + docker-compose up diff --git a/70_installation/5_Generic.md b/70_installation/5_Generic.md index 1fa46e9..8ee41c3 100644 --- a/70_installation/5_Generic.md +++ b/70_installation/5_Generic.md @@ -27,7 +27,7 @@ If you want to use IP cameras, make sure to compile FFMPEG with x264 support. git clone https://github.com/FFmpeg/FFmpeg ffmpeg cd ffmpeg && git checkout remotes/origin/release/2.8 ./configure --enable-gpl --enable-libx264 --enable-shared --prefix=/usr/local - make && sudo make install + make && sudo make install Go to home directory and pull the machinery from github. @@ -40,7 +40,7 @@ Compile the machinery; this can take some time. Start the machinery on start-up. - sudo systemctl enable kerberosio + sudo systemctl enable kerberosio ### Configure @@ -58,18 +58,42 @@ After kerberos is installed a binary is available at **/usr/bin/kerberosio**. Ju ## Web -### Install webserver + PHP (optional) +### Install web -Update the packages and kernel. +If you want to install **the web**, you'll need to have **a webserver** (e.g. Nginx) and **PHP** running with some extensions. You also need **NodeJS** and **npm** installed to install **Bower**. Below you can find the installation procedure to install the web on your preferred environment. + +#### Install Dependencies + +Install Git, PHP7 (+extensions) and NodeJS. + +A) Ubuntu sudo apt-get update && sudo apt-get upgrade - -Install git, nginx, php (+extension) and nodejs. - curl -sL https://deb.nodesource.com/setup | sudo bash - - sudo apt-get install git nginx php5-cli php5-fpm php5-gd php5-mcrypt php5-curl nodejs + sudo apt-get install git nginx php7.0-cli php7.0-gd php7.0-mcrypt php7.0-curl php7.0-mbstring php7.0-dom php7.0-zip php7.0-fpm nodejs npm -Creating a nginx config. +B) Raspbian + + echo "deb http://mirrordirector.raspbian.org/raspbian/ stretch main contrib non-free rpi" | sudo tee --append /etc/apt/sources.list + sudo apt-get update + sudo apt-get install -t stretch php7.0 php7.0-curl php7.0-gd php7.0-fpm php7.0-cli php7.0-opcache php7.0-mbstring php7.0-xml php7.0-zip php7.0-mcrypt nodejs npm + sudo ln -s /usr/bin/nodejs /usr/bin/node + +C) OSX + + brew install php7.0 php7.0-curl php7.0-gd php7.0-fpm php7.0-cli php7.0-opcache php7.0-mbstring php7.0-xml php7.0-zip php7.0-mcrypt nodejs npm + +#### Configure webserver + +Install Nginx, + + sudo apt-get install nginx + +or if you're running OSX use brew. + + sudo brew install nginx + +Creating a Nginx config. sudo rm -f /etc/nginx/sites-enabled/default sudo nano /etc/nginx/sites-enabled/default @@ -95,18 +119,13 @@ Copy and paste following config file; this file tells nginx where the web will b location ~ \.php$ { - fastcgi_pass unix:/var/run/php5-fpm.sock; + fastcgi_pass unix:/var/run/php/php7.0-fpm.sock; fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name; include fastcgi_params; } } -Restart nginx - - sudo service nginx restart - - -### Install source +#### Clone source Create a www location. @@ -124,16 +143,19 @@ Install PHP packages by using composer. Add write permission for the storage directory, and the kerberos config file. - sudo chmod -R 777 app/storage - sudo chmod 777 app/config/kerberos.php + sudo chmod -R 777 storage + sudo chmod -R 777 bootstrap/cache + sudo chmod 777 config/kerberos.php -Install bower globally by using node package manager, this is installed when installing nodejs. +Install bower globally by using npm. - sudo apt-get install npm - sudo ln -s /usr/bin/nodejs /usr/bin/node sudo npm -g install bower Install Front-end dependencies with bower cd public sudo bower --allow-root install + +Reboot + + sudo reboot