suppliers:hvac.io:vigilia:installation
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
suppliers:hvac.io:vigilia:installation [2015/09/14 14:32] – [vigilia-server.jar] frozenlock | suppliers: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: | ||
- | ====== | + | ====== Installation ====== |
- | //**For self-hosted version only.** To use the HVAC.IO servers instead, [[https:// | + | For self-hosted version only. To use the HVAC.IO servers instead, [[https:// |
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/ | + | 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:// | Download and install by following the instructions on this [[https:// | ||
- | 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. | ||
- | |||
- | {{: | ||
- | |||
- | You can stop the process by pressing Ctrl-C in the shell. | ||
===== Vigilia Server ===== | ===== Vigilia Server ===== | ||
Line 63: | Line 55: | ||
< | < | ||
- | (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: | ||
< | < | ||
- | === Create Admin Account === | ||
- | If Vigilia is able to connect to the database, you will be invited to create an account. | + | Obviously, 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 === | + | |
- | + | ||
- | 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: | + | |
- | + | ||
- | {{: | + | |
- | + | ||
- | + | ||
- | === 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, | + | |
- | + | ||
- | In the administration page, click on " | + | |
- | Click on the " | + | |
- | + | ||
- | Once the organization is created, click on its link. | + | |
- | + | ||
- | {{: | + | |
- | + | ||
- | + | ||
- | === 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 " | + | |
- | + | ||
- | Next, click on the configuration button. | + | |
- | + | ||
- | {{: | + | |
- | + | ||
- | 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 Wacnet | + | |
- | + | ||
- | To start logging a network, **begin by running Wacnet**. | + | |
- | Then go and configure a few things in the **[[http:// | + | |
- | + | ||
- | ==== 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: | + | |
- | + | ||
- | < | + | |
- | http://< | + | |
- | </ | + | |
- | + | ||
- | + | ||
- | Make sure Wacnet can see the provided URL! | + | |
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | {{: | + | |
- | + | ||
- | ==== Step 2: Project credentials ==== | + | |
- | + | ||
- | You have to provide a **project ID** and a **logging key/ | + | |
- | 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 : | + | |
- | + | ||
- | {{: | + | |
- | + | ||
- | + | ||
- | ==== 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 " | + | |
- | {{: | ||
===== 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