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
suppliers:hvac.io:vigilia:installation [2015/09/27 19:03] – [Adding Vigilia as a Service] frozenlocksuppliers:hvac.io:vigilia:installation [2020/10/04 01:53] (current) – old revision restored (2020/10/02 09:00) 173.249.2.13
Line 1: Line 1:
-====== Vigilia Installation ======+====== Vigilia Server Installation ======
  
-//**For self-hosted version only.** To use the HVAC.IO servers instead, [[https://hvac.io/registration|create an account]] and jump to [[#Loggers]].//+//**Requires a Viglia Server licence**To use the official HVAC.IO servers instead, jump to [[.:recording]].//
  
 The installation is separated in 3 main components: The installation is separated in 3 main components:
Line 7: Line 7:
   * [[#Database]]   * [[#Database]]
   * [[#Vigilia Server]]   * [[#Vigilia Server]]
-  * [[#Loggers]]+  * [[.:recording#client_side_loggers|Loggers]]
  
 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.
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 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.)
  
  
-TokuMX is supported on **64-bit Linux only**, but 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. We recommend to use SSD drives, as their increased speed directly translate in how fast Vigilia will react.
 250 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!) 250 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 :
  
-Download and install by following the instructions on this [[https://www.percona.com/downloads/percona-tokumx-community-edition|page]].+<code> sudo apt install tokumx-enterprise </code> 
 + 
 +(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 Once the database is installed, make sure everything works as intended by running the command
Line 77: Line 80:
  
 Now that you have the administrator rights, you should load the license files. 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.+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: You should see something similar to this:
  
 {{:suppliers:hvac.io:vigilia:installation:license.png|}} {{: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) === === 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.+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.
  
-===== Loggers =====+=== Good to Go ===
  
-Loggers are software able to scan a BACnet network and send the data back to a Vigilia server.+Once your Vigilia server is up and running, you can follow the steps to [[suppliers:hvac.io:vigilia:recording|record a BACnet network]].
  
-The only publicly available logger is [[https://hvac.io/docs/wacnet|Wacnet]] (min version 1.8). 
  
-To start logging network, **begin by running Wacnet**.+===== Adding Vigilia as Service ===== 
 +==== (Upstart Users) ====
  
-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 ===== 
  
 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. 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 184: Line 108:
  
  
-<code bash>+<code bash vigilia.conf>
  
 description "Vigilia Server" description "Vigilia Server"
Line 220: Line 144:
 To get more info about Upstart and services, see http://upstart.ubuntu.com/cookbook/. 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>
 +
 +If you are using **systemd**, you might need to [[https://superuser.com/a/1322187|update a different file]].
suppliers/hvac.io/vigilia/installation.1443380629.txt.gz · Last modified: 2015/09/27 15:03 (external edit)