Differences

This shows you the differences between two versions of the page.

--- suppliers:hvac.io:vigilia:installation [2017/08/26 00:07] – [Database] frozenlock
+++ suppliers:hvac.io:vigilia:installation [2020/07/22 09:33] – old revision restored (2015/09/11 20:59) 173.208.218.130
@@ Line 1: / Line 1: @@
-====== Vigilia Server Installation ======
+====== Vigilia Installation ======
-//**Requires a Viglia Server licence**. To use the HVAC.IO servers instead, jump to [[.:recording]].//
+//**For self-hosted version only.** To use the HVAC.IO servers instead, [[https://hvac.io/registration|create an account]] and jump to [[#Loggers]].//
 The installation is separated in 3 main components:
@@ Line 7: / Line 7: @@
   * [[#Database]]
   * [[#Vigilia Server]]
-  * [[.:recording#client_side_loggers|Loggers]]
+  * [[#Loggers]]
 They can all be installed on the same machine, or on separate servers and devices, depending on your network architecture.
@@ Line 14: / Line 14: @@
 Once this is done, you might want to take a look at [[#Adding Vigilia as a Service]]
 ===== Database =====
-For the time being, Vigilia only supports TokuMX.
+For the time being, Vigilia only supports [[https://www.percona.com/software/mongo-database/percona-tokumx|TokuMX]].
 It is a fork of MongoDB, which features mind boggling increase in performance and reduction in the database size.
 (The choice was not made lightly; we tried many databases before settling with this one.)
-TokuMX is supported on **64-bit Linux only**, but a virtual image should work too.
+TokuMX is supported on **64-bit Linux only**, but virtual image should work too.
 We recommend to use SSD drives, as their increased speed directly translate in how fast Vigilia will react.
 to 500 Go should be plenty of space to store many years of data for networks composed of hundreds of thousands of objects. (Tokumx compression is really useful for this!)
-To install TokuMX, add the following [[https://launchpad.net/~exponea/+archive/ubuntu/tokumx|PPA]] and enter the following in your shell :
-<code> sudo apt install tokumx-enterprise </code>
+Download and install by following the instructions on this [[https://www.percona.com/downloads/percona-tokumx-community-edition|page]].
-(Alternatively, you can try to follow the official instructions on this [[https://www.percona.com/doc/percona-tokumx/installation.html|page]].)
-Once the database is installed, make sure everything works as intended by running the command
-**mongo** in the shell.
-The command should be recognized AND it should connect successfully.
-{{:suppliers:hvac.io:vigilia:installation:tokumx-shell.png?|}}
-You can stop the process by pressing Ctrl-C in the shell.
 ===== Vigilia Server =====
@@ Line 66: / Line 55: @@
 <code> java -jar vigilia-server.jar <port number> </code>
-(where <port number> is the port you want to use. If you don't know which one to take, use 47900.)
+(where <port number> is the port you want to use.)
 After a few seconds, the server should be up and running.
@@ Line 72: / Line 61: @@
 <code> http://localhost:<port number> </code>
-=== Create Admin Account ===
-If Vigilia is able to connect to the database, you will be invited to create an account.
+If you want the application to start automatically when your server boot up, you should make sure to [[#Adding Vigilia as a Service|create a service]], or configure your web server (like Tomcat) to use vigilia-server.jar.
-The first account created will have the administrator rights.
-=== Load License ===
+===== Loggers =====
-Now that you have the administrator rights, you should load the license files.
+Loggers are software able to scan a BACnet network and send the data back to a Vigilia server.
-On the upper right, you should see your username. Click on it and go to **Server Administration**. Then click on **License**. Select the license files and click upload.
-You should see something similar to this:
+The only publicly available logger is Wacnet (min version 1.8).
-{{:suppliers:hvac.io:vigilia:installation:license.png|}}
+To start logging a network, you need to configure a few things in the **Vigilia Configs** page :
-=== Configure Service (optional) ===
-If you want the application to start automatically when your server boot up, you should make sure to [[#Adding Vigilia as a Service|create a service]] (shown below), or configure your web server (like Tomcat) to use vigilia-server.jar.
+==== Step 1: Connect to a Vigilia server ====
-=== Good to Go ===
+//**For self-hosting only.** Users of HVAC.IO's Vigilia service should jump to the next step.//
-Once your Vigilia server is up and running, you can follow the steps to [[suppliers:hvac.io:vigilia:recording|record a BACnet network]].
+The first thing to configure is a Vigilia API URL. This will tell Wacnet where it should send its data.
+It should have the following form:
-===== Adding Vigilia as a Service =====
+<code>
-==== (Upstart Users) ====
+http://<vigilia-IP-or-adrress>/api/v1
+</code>
+Make sure Wacnet can see the provided URL!
+{{:suppliers:hvac.io:vigilia:installation:logger-step1.png|}}
+==== Step 2: Project credentials ====
+You have to provide a **project ID** and a **logging key/password**.
+Both are available through the project configurations on the Vigilia server.
+Here's an example :
+  * Project-id : 5371147be4b0222b740851a2
+  * Logging key: asdi34h5ha
+Make sure Wacnet has access to the project :
+{{:suppliers:hvac.io:vigilia:installation:logger-step2.png?800}}
+==== Start Logging ====
+When Wacnet starts, it searches for Vigilia configurations. If it finds some, **it will start logging automatically**.
+To start the logging without restarting Wacnet, expand the details part of the page and click on "Start".
+{{:suppliers:hvac.io:vigilia:installation:logger-step-start.png?500|}}
+===== Adding Vigilia as a Service =====
 You might want to make sure the Vigilia server always starts as soon as the server boots, or that it restores itself in case of a crash.
@@ Line 108: / Line 126: @@
-<code bash vigilia.conf>
+<code shell>
 description "Vigilia Server"
@@ Line 143: / Line 161: @@
 To get more info about Upstart and services, see http://upstart.ubuntu.com/cookbook/.
-===== Troubleshooting =====
-==== Database Crash ====
-If you database is becoming quite large (thousands of files in the dbpath), it's possible that your OS is going to refuse opening that much files simultaneously.
-In Linux, you can change the number of allowed files by editing the file ''/etc/security/limits.conf'' and adding the following lines :
-<code>
-tokumx soft nofile 1000000
-tokumx hard nofile 1000000
-</code>