Differences

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

--- suppliers:hvac.io:vigilia:installation [2015/12/04 19:29] – [Adding Vigilia as a Service] frozenlock
+++ suppliers:hvac.io:vigilia:installation [2020/10/04 01:52] – old revision restored (2020/10/02 09:00) 173.249.2.13
@@ Line 1: / Line 1: @@
 ====== Vigilia Installation ======
-//**For self-hosted version only.**
+//**For self-hosted version only.** To use the HVAC.IO servers instead, [[https://hvac.io/registration|create an account]] and jump to [[#Loggers]].//
-To use the HVAC.IO servers instead, jump to [[.:recording]].//
 The installation is separated in 3 main components:
@@ Line 9: / 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 16: / 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.)
@@ Line 27: / Line 25: @@
-Download and install by following the instructions on this [[https://www.percona.com/doc/percona-tokumx/installation.html|page]].
+Download and install by following the instructions on this [[https://www.percona.com/downloads/percona-tokumx-community-edition|page]].
 Once the database is installed, make sure everything works as intended by running the command
@@ Line 36: / Line 34: @@
 {{:suppliers:hvac.io:vigilia:installation:tokumx-shell.png?|}}
-You can stop the process by pressing Ctrl-C in the shell.
 ===== Vigilia Server =====
@@ Line 71: / Line 68: @@
 <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.
+===== Loggers =====
+Loggers are software able to scan a BACnet network and send the data back to a Vigilia server.
+The only publicly available logger is Wacnet (min version 1.8).
+To start logging a network, **begin by running Wacnet**.
+Then go and configure a few things in the **[[http://localhost:47800/vigilia/configs|Vigilia Configs]]** page :
+==== Step 1: Connect to a Vigilia server ====
+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:
+<code>
+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 ====
-=== Load License ===
+You have to provide a **project ID** and a **logging key/password**.
+Both are available through the project configurations on the Vigilia server.
-Now that you have the administrator rights, you should load the license files.
+Here's an example :
-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.
+  * Project-id : 5371147be4b0222b740851a2
+  * Logging key: asdi34h5ha
-You should see something similar to this:
+Make sure Wacnet has access to the project :
-{{:suppliers:hvac.io:vigilia:installation:license.png|}}
+{{:suppliers:hvac.io:vigilia:installation:logger-step2.png?800}}
-=== 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.
+==== Start Logging ====
-=== Good to Go ===
+When Wacnet starts, it searches for Vigilia configurations. If it finds some, **it will start logging automatically**.
-Once your Vigilia server is up and running, you can follow the steps to [[suppliers:hvac.io:vigilia:recording|record a BACnet network]].
+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 =====
@@ Line 105: / Line 131: @@
-<code bash vigilia.conf>
+<code shell>
 description "Vigilia Server"