HVAC Wiki

All things related to HVAC

User Tools

Site Tools


suppliers:hvac.io:vigilia:installation

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revisionBoth sides next revision
suppliers:hvac.io:vigilia:installation [2020/07/22 09:33] – old revision restored (2015/09/11 20:59) 173.208.218.130suppliers:hvac.io:vigilia:installation [2020/07/22 15:01] – old revision restored (2015/07/30 01:52) 95.91.41.38
Line 1: Line 1:
-====== Vigilia Installation ======+====== Installation ======
  
-//**For self-hosted version only.** To use the HVAC.IO servers instead, [[https://hvac.io/registration|create an account]] and jump to [[#Loggers]].//+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: The installation is separated in 3 main components:
Line 11: Line 11:
 They can all be installed on the same machine, or on separate servers and devices, depending on your network architecture. They can all be installed on the same machine, or on separate servers and devices, depending on your network architecture.
  
- 
-Once this is done, you might want to take a look at [[#Adding Vigilia as a Service]] 
 ===== Database ===== ===== Database =====
-For the time being, Vigilia only supports [[https://www.percona.com/software/mongo-database/percona-tokumx|TokuMX]].+For the time being, Vigilia only supports [[http://www.tokutek.com/tokumx-for-mongodb/|TokuMX]].
 It is a fork of MongoDB, which features mind boggling increase in performance and reduction in the database size. 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.) (The choice was not made lightly; we tried many databases before settling with this one.)
Line 25: Line 23:
  
  
-Download and install by following the instructions on this [[https://www.percona.com/downloads/percona-tokumx-community-edition|page]].+Download and install by following the instructions on this [[http://www.tokutek.com/tokumx-for-mongodb/download-community/|page]].
  
 ===== Vigilia Server ===== ===== Vigilia Server =====
Line 31: Line 29:
 For maximum speed, we recommend you install the Vigilia server on the same machine as the database. For maximum speed, we recommend you install the Vigilia server on the same machine as the database.
  
-Vigilia server runs on [[http://www.java.com|Java]], meaning it can work on Linux, Windows and Mac.+Vigilia server runs on [[www.java.com|Java]], meaning it can work on Linux, Windows and Mac.
  
  
Line 57: Line 55:
 (where <port number> is the port you want to use.) (where <port number> is the port you want to use.)
  
-After a few seconds, the server should be up and running.  +Obviouslyif you want the application to start automatically when your server boot up, you should make sure to create a service, or configure your web server (like Tomcat) to use vigilia-server.jar.
-You can now take your browser and go to+
-<code> http://localhost:<port number> </code>+
  
- 
-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. 
  
 ===== Loggers ===== ===== 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, you need to configure a few things in the **Vigilia Configs** page : 
- 
- 
-==== Step 1: Connect to a Vigilia server ==== 
- 
-//**For self-hosting only.** Users of HVAC.IO's Vigilia service should jump to the next step.// 
- 
-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 ==== 
- 
-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. 
- 
-For this, you'll have to add Vigilia as a service. 
- 
-Start by creating a file named "**vigilia.conf**". 
- 
-Open it and paste the following: 
- 
- 
-<code shell> 
- 
-description "Vigilia Server" 
-author "Christian Fortin, HVAC.IO" 
- 
-start on runlevel [2345] 
-stop on runlevel [!2345] 
- 
- 
-#Respawn the process if it crashes 
-#If it respawns more than 10 times in 60 seconds stop 
-respawn 
-respawn limit 10 60 
- 
-expect fork 
- 
-#replace PATH-TO-THE-JAR with something like /home/hvacio/vigilia 
-#replace PORT with the desired port number 
-script 
-    cd PATH-TO-THE-JAR 
-    java -jar vigilia-server.jar PORT & 
-end script 
- 
-</code> 
- 
-Now, once you replaced PATH-TO-THE-JAR and PORT with their correct values, move the file to /etc/init: 
- 
-<code> 
-sudo mv vigilia.conf /etc/init/vigilia.conf 
-</code> 
- 
-That's it! 
-Now reboot and Vigilia should start automatically. 
- 
-To get more info about Upstart and services, see http://upstart.ubuntu.com/cookbook/. 
- 
suppliers/hvac.io/vigilia/installation.txt · Last modified: 2020/10/04 01:53 by 173.249.2.13