Personal tools

Difference between revisions of "Installation"

From PhotoVoltaic Logger new generation

Jump to: navigation, search
m (→‎Via Web frontend)
m (→‎Core repository)
 
(42 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{TOCright}}
 
{{TOCright}}
 +
== Software requirements ==
 +
* Operating system with support of periodic job scheduling (for example *nix with cron)
 +
* MySQL ≥ 5.1 (supports table partitions, views, trigger, functions, procedures and events)
 +
* PHP ≥ 5.3
 +
* Web server with PHP support, tested with Nginx (recommended), Apache and Litespeed
 +
 +
'''See also these [[Software hints|hints]] for details!'''
 +
 
== Hardware requirements ==
 
== Hardware requirements ==
−
* A server, which fits the software requirements :-)
+
* A server, which fits the software requirements :-)<br />A Raspberry B with a 4 GB SD card works fine for me as scripts server connected to a central frontend/API sever.
−
* Some sensors, like [[1-Wire sensor]]s, watt meters
+
* Some sensors, like [[1-Wire sensor]]s, watt meters with [[S0 reader|S0]] or [[D0 reader|D0]] outputs
 
* Solar inverter which supports either
 
* Solar inverter which supports either
−
** live query of data ([[SMA Webbox]], [[Grouping models#Fronius\SolarNet|Fronius]], [[Grouping models#Kaco|Kaco]]
+
** live query of data ([[SMA Webbox]], [[Grouping models#Fronius\SolarNet|Fronius]], [[Grouping models#Kaco|Kaco]], [[Grouping models#Kostal|Kostal]])
 
** write data in short intervals (quasi-live) somewhere
 
** write data in short intervals (quasi-live) somewhere
−
 
−
== Software requirements ==
 
−
* Operating system with support of periodic job scheduling (for example *nix with cron)
 
−
* MySQL ≥ 5.1.* (supports table partitions, views, trigger, functions, procedures and events)
 
−
* PHP ≥ 5.3.*
 
−
* Web server with PHP support, tested with Apache, Litespeed and Nginx (recommended)
 
  
 
== Installation ==
 
== Installation ==
  
−
At 1st find the document root of your web server, usually <tt>/var/www/htdocs</tt>, <tt>/var/htdocs</tt>, <tt>/srv/www/htdocs</tt> ...
+
The system is devided into 2 repositories, the PVLng core repo with [[:Category:Web_frontend|web frontend]] and [[API]] and the [[:Category:Scripts|PVLng-Scripts]] repo with the data aquisition and extraction scripts.
  
−
If you want to run only PVLng on your server, just install PVLng direct into the document root.
+
* [[Core repository installation instructions|Installation instructions]] for {{PVLngRepo}}
 +
* [[Scripts repository installation instructions|Installation instructions]] for {{PVLngScriptsRepo}}
  
−
If you have more running on your server, setup a own document root for PVLng.
+
[[Category:Hardware]]
−
 
+
[[Category:Software]]
−
=== Install with Git ===
 
−
 
 
−
==== Stable ====
 
−
 
 
−
If your system have Git installed, it will be simplest way to clone the Github repositories from GitHub.
 
−
 
 
−
Go into the directory, you will PVLng install to and execute
 
−
 
 
−
$ wget -qO - <nowiki>https://raw.github.com/K-Ko/PVLng/master/install</nowiki> | bash
 
−
 
 
−
The installer will ask for your MySQL credentials, install the basic SQL script and create a basic configuration file with this credentials.
 
−
 
 
−
==== Development ====
 
−
 
 
−
If you are interested in the latest development version, you can also direct install the development branch with
 
−
 
 
−
$ wget -qO - <nowiki>https://raw.github.com/K-Ko/PVLng/develop/install</nowiki> | bash
 
−
 
 
−
Open afterwards your installation in your browser to finalize the setup.
 
−
 
 
−
=== Manual installation ===
 
−
 
 
−
Just download the archive and extract it direct on your server.
 
−
 
 
−
$ wget <nowiki>https://github.com/K-Ko/PVLng/zipball/master</nowiki> -O master.zip
 
−
$ unzip master.zip
 
−
$ mv PVLng-master/* .
 
−
$ rm -r master.zip PVLng-master
 
−
 
 
−
=== Database setup ===
 
−
 
 
−
Create a database for PVLng if you want. (This is ''recommend'', but not required)
 
−
 
 
−
All PVLng specific tables have a <tt>pvlng_</tt> as prefix.
 
  
−
Import the SQL file <tt>sql/install.sql</tt> into your database.
+
== Upgrade ==
 +
=== Core repository ===
 +
Your can upgrade your installation at any time with
  
−
==== From command line ====
+
$ tools/upgrade.git
 +
 +
Upgrade your installation to lastest state from Github.
 +
 +
Usage: tools/upgrade.git <branch>
  
−
$ mysql -u[username] -p[password] [database] <sql/pvlng.sql
+
This works with <tt>master</tt> and <tt>develop</tt>
−
 
+
* Checkout the lastest changes from GitHub
−
This will install all the required tables, a predefined set of channel types, a view and some functions.
+
* Apply outstanding database patches if any
−
 
 
−
==== Via Web frontend ====
 
−
 
 
−
PVLng have Adminer installed by default.
 
−
 
 
−
<blockquote>Adminer (formerly phpMinAdmin) is a full-featured database management tool written in PHP. Conversely to phpMyAdmin, it consist of a single file ready to deploy to the target server.
 
−
<cite>http://www.adminer.org</cite></blockquote>
 
−
 
 
−
<nowiki>http://your.domain.here/adminer/</nowiki>
 
−
 
 
−
Choose <tt>SQL-Query > File upload > Execute</tt>
 
−
 
 
−
== Configuration ==
 
−
 
 
−
Prepare the configuration file:
 
−
 
 
−
$ cp config/config.php.dist config/config.php
 
−
 
 
−
=== Database ===
 
−
 
 
−
Fill in <tt>config.php</tt> your database credentials.
 
  
 
=== Scripts repository ===
 
=== Scripts repository ===
  
−
Prepare the configuration file:
+
Just pull the latest changes from GitHub
−
 
+
  git checkout master
−
  $ cp PVLng.conf.dist PVLng.conf
+
or
−
 
+
git checkout develop
−
Fill in at least your API key, you can find it on the [[Information module|information]] page.
+
and
−
 
+
git pull
−
Open afterwards your installation in your browser to finalize the setup.
 
−
 
 
−
[[Category:Hardware]]
 
−
[[Category:Software]]
 

Latest revision as of 20:23, 6 August 2016

Software requirements

  • Operating system with support of periodic job scheduling (for example *nix with cron)
  • MySQL ≥ 5.1 (supports table partitions, views, trigger, functions, procedures and events)
  • PHP ≥ 5.3
  • Web server with PHP support, tested with Nginx (recommended), Apache and Litespeed

See also these hints for details!

Hardware requirements

  • A server, which fits the software requirements :-)
    A Raspberry B with a 4 GB SD card works fine for me as scripts server connected to a central frontend/API sever.
  • Some sensors, like 1-Wire sensors, watt meters with S0 or D0 outputs
  • Solar inverter which supports either

Installation

The system is devided into 2 repositories, the PVLng core repo with web frontend and API and the PVLng-Scripts repo with the data aquisition and extraction scripts.

Upgrade

Core repository

Your can upgrade your installation at any time with 

$ tools/upgrade.git

Upgrade your installation to lastest state from Github.

Usage: tools/upgrade.git <branch>

This works with master and develop

  • Checkout the lastest changes from GitHub
  • Apply outstanding database patches if any

Scripts repository

Just pull the latest changes from GitHub 

git checkout master

or 

git checkout develop

and 

git pull
Retrieved from "http://pvlng.com/index.php?title=Installation&oldid=1581"