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 revision
Previous revision
Next revisionBoth sides next revision
suppliers:hvac.io:vigilia:installation [2015/09/27 19:02] – [Loggers] frozenlocksuppliers:hvac.io:vigilia:installation [2020/10/04 01:51] – old revision restored (2020/09/23 18:50) 173.249.2.13
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 14: Line 14:
 Once this is done, you might want to take a look at [[#Adding Vigilia as a Service]] 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 27: Line 27:
 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 [[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 
-**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 ===== ===== Vigilia Server =====
  
Line 63: Line 55:
  
 <code> java -jar vigilia-server.jar <port number> </code>  <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.  After a few seconds, the server should be up and running. 
Line 69: Line 61:
 <code> http://localhost:<port number> </code> <code> http://localhost:<port number> </code>
  
-=== Create Admin Account === 
  
-If Vigilia is able to connect to the databaseyou will be invited to create an account. +Obviouslyif 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 === +
- +
-Now that you have the administrator rights, you should load the license files. +
-Go to **Administration** and then **License**. Select the license files and click upload. +
- +
-You should see something similar to this: +
- +
-{{:suppliers:hvac.io:vigilia:installation:license.png|}} +
- +
- +
-=== Create an Organization === +
- +
-Organizations can have multiple members and contain many projects.  +
-A member will see all the organization projects. +
- +
-Most will not need more than a single organization, so you can just use your own enterprise name. +
- +
-In the administration page, click on "Organizations" (or go to your account page). +
-Click on the "Create organization" button and create it. +
- +
-Once the organization is created, click on its link. +
- +
-{{:suppliers:hvac.io:vigilia:installation:org-link.png|}} +
- +
- +
-=== Create a Project === +
- +
-Projects are what contains the recorded data. +
-Inside a project, **all BACnet device IDs must be unique**. +
- +
-In your organization page, click on "Create project" and create it. +
- +
-Next, click on the configuration button. +
- +
-{{:suppliers:hvac.io:vigilia:installation:project-config.png|}} +
- +
-This will bring you to a page with the **project-id** and the **logger-key**.  +
-You will need both to configure the logger(s). +
- +
- +
-=== 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]], 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. +Wacnet...
- +
-The only publicly available logger is [[https://hvac.io/docs/wacnet|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-address>/api/v1 +
-</code> +
- +
-If you are using a port other than 80 or 443, you need to include it into the URL: +
- +
-<code> +
-http://<vigilia-IP-or-address:47900>/api/v1 +
-</code> +
-(Where 47900 is your port number) +
- +
-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 ===== ===== Adding Vigilia as a Service =====
suppliers/hvac.io/vigilia/installation.txt · Last modified: 2020/10/04 01:53 by 173.249.2.13