/
Example of the server configuration for a basic project
Document toolboxDocument toolbox

Example of the server configuration for a basic project

Owned by Vladislav Turzai
Nov 12, 2024
19 min read

Here you can find an example of a complete server (with SIP) configuration for 1 house project: 

1. Configure basic server settings for the correct functioning:

2. Add user profiles for various users and configure their permissions. 

In general, 3 profiles are enough for the basic project, and they are created by default:  

  • administrator controls the whole system and has all possible permissions to perform system installation, configuration, and support.

  • concierge interacts with residents and visitors, manages access conditions, and sends announcements and messages: announces (can create/edit/delete/send announces, can view particular announces); calls (can receive call like concierge, can call to intercom); conversations (can create conversation/conversation message, can accept messages from descendant users); devices (can view devices, can view device events); elevators (can view elevators); emergency alerts (can view emergency alerts, can playback emergency alerts); group types (can view group type); markers (can view marker). 

  • user is a profile for residents with the following permissions: access restrictions (can view/create/delete access rules); announces (can particular announces); calls (can call to intercom); conversations (can create conversation/conversation message); devices (can view devices/all devices); group types (can view group type); identifiers (can view particular identifiers; can create/delete identifiers; can create guest identifiers, can export identifiers); profiles (can view available roles only). 

If necessary, you can edit these profiles in the corresponding tab and add other permissions or create new profiles:  

  1. Go to the Profiles tab of the User management section.

  2. Click the plus icon (in the low left corner).

  3. Enter a profile name and add a description (if required).

  4. Select the required permissions.

  5. Save data by clicking the corresponding button in the low left corner.

Also, it is possible to use one server for several small projects, e.g., for some separate areas with few devices. You can read about this configuration by following the link.

3. Add a group for the house/s. 

For example, there is 1 house with 2 units, 20 floors, and 4 apartments on each floor. So, manual group creation for example looks like this: 

  1. Go to the Groups tab in the User management section.

  2. Click Add group and select Add root group.

  3. Enter a group name, e.g. Heathfield House1.

  4. Select сustom for type.  

  5. Add a description, if necessary.

  6. Click the Save button in the low left corner when all required data is entered.

When the root (basic) group is created, you are required to add subgroups for each unit, floor, and apartment. To do this: 

  1. Find previously created root group in the list. 

  2. Click 3 dots near the group name.

  3. Select a new group. A menu for adding a group will open.  

  4. Enter all data that you've entered for the root group, but pay attention that this group stands for unit:   

    • enter a group name, e.g. Unit 1.

    • Select unit for type.

    • Enter a logical address: Unit No., e.g. 1. 

    • Add a description, if necessary.

  5. Click the Save button in the low left corner when all required data is entered.

  6. Repeat steps 1-5 to add a group for the 2nd unit. Pay attention, logical address must differ for the 2nd unit. 

  7. Repeat steps 1-5 to add subgroups for 20 floors in every unit and 4 apartments on each floor. Select the corresponding group type. Pay attention, that subgroups for floors must be added to a unit group, and subgroups for apartments must be added to a floor group.       

As a result, you will receive the following hierarchy: 

Also, you can enter data about groups you are required to create and they can be generated automatically. Detailed steps you can read here or watch the video.    

Further, you must add users and devices to the required subgroup (unit/floor/apartment) and set access restrictions for them.  

4. Add users to the system.   

All residents and service staff must be added to the Link: 

  1. Open the User tab of the User management section.

  2. Click the plus icon in the low left corner.

  3. Enter a user name.

  4. Add a user photo if necessary.

  5. Select the user profile (from created in the previous steps).

  6. Enter the user email to send the registration link.

  7. Enter user phone number if necessary.   

  8. If necessary, enter user address.

  9. Add a user to a corresponding group. For example, Mr. Clark lives on the 2nd floor of the 1st unit in Heathfield House1. So, you must add Mr. Clark exactly to this group. 

     

  10. Set available for user licenses that they purchased (this section is available if you have the can edit user licenses permission assigned to your profile).

  11. Click the Save button in the low left corner when all necessary data is entered.

Further, you must add identifiers and set access restrictions for users. 

Applying licenses to users

You can manage user licenses only if the Can edit user licenses permission assigned to your profile. By default, 1 license for an apartment includes 1 mobile app, i.e., only 1 user can use the Link app if 1 mobile app license is applied. So, if there is more than 1 resident in the apartment, you as the administrator must do the following configurations so all users can use the Link app:

  1. Add a user to the Link server as described in the previous section.

  2. Be sure that you are adding the user to the correct group.

  3. Enable and set the number of licenses for mobile application according to the number of apartment residents. 

  4.  Usually, users invite other apartment residents via the mobile app. Wait for the user to add their family members which be displayed in the corresponding section of the user entity. A user added the an administrator is considered as the main. Family members added by the main user are considered sub-users. Family members are automatically added to the main user group. Also, they get the same rights as the one who invited them but cannot invite/remove other users, configure a forwarding queue for an apartment, or subscribe to family members actions. Only the main user has rights to all these features. 

  5. Create identifier(s) for added family member(s) as described here.

  6. If required, create or apply access restrictions to added family member(s). But, we recommend applying access restrictions to an apartment group instead of each user.

As a result, all users have licenses for mobile app and all other required data. 

 

The other possible way of applying licenses is adding users without the mobile app. So, you as the administrator:  

  1. Add all apartment residents to the Link server as described in the previous section.

  2. Be sure that you are adding users to the correct group.

  3. Enable and set 1 mobile application license for each user.

  4. Create identifier(s) for all apartment residents as described here if you skipped it in the 1st step.

  5. If required, or if you skipped it in the 1st step, create or apply access restrictions to all apartment residents. But, we recommend applying access restrictions to an apartment group instead of each user.

As a result, all users have licenses for mobile app and all the necessary data. However, links main and sub-user are lost, and all users added by the administrator are now considered as main. Consequently, they all can invite/remove other users and configure a forwarding queue for an apartment. This may lead to misunderstandings and some features malfunctions. Additionally, subscription to family members actions will not work as no one is considered a family member.  

Also, you must add users for cleaners and security guards completing the previously described steps. Depending on what access they must have, you can add them to the root (house) group, e.g. Heathfield House1, or to the exact unit/floor group. If you add a user to the root group, they can pass only devices added to this root group, so they can only enter the house territory. This variant is appropriate for security guards. If you add user to unit group/s (e.g. a cleaner), they can use devices added to the root and unit group, so they can enter the house territory and unit/s. 

5. Add devices to the system.

All devices (panels, controllers, monitors) must be added to the Link server to associate physical devices with data on the server. To do it:

  1. Go to the Devices tab of the Device management section.

  2. Click plus icon in the low left corner.

  3. Enter the device name.

  4. Select its type: panel, monitor, access controller.

  5. Select the device model.

  6. Indicate the device Serial number (check the Dashboard tab of the device web interface or device box).

  7. Select a group/subgroup where the device is installed.

  8. Set panels location geodata. This data is required for the Link app, when a visitor with a pass (added to Apple Wallet) approaches the available panel (with location), the pass will be automatically shown.

  9. Add a description, if necessary.

  10. Enable using a camera to identify license plates, if necessary. 

  11. Allow remote lock opening (from the device web interface, via API), if necessary. 

  12. Enter network settings for server and panel interaction:

    • select the MQTT communication protocol.

    • enter the device IP address and port (for HTTP only).

    • enter login and password that are used to enter the device web interface.

    • indicate server interaction password (is created in the Management system section (Network tab) of the device web interface).

Also, the same network settings as for the server must be entered in the device web interface. The management system must be enabled for the device:

  1. Log in to the device web interface. By default, the username is admin, and the password is 123456.

  2. Go to the Network tab > Management system section.

  3. Select the MQTT protocol.

  4. Enter all required data. 

  5. Submit settings.

 Detailed instructions are here.

As an example, there is 1 entrance panel in the Heathfield House1 to access its territory, 1 panel is near the entrance for each unit and each floor, and 1 monitor is in each apartment. So, repeat all previous steps to add each device for the corresponding group. 

Also, you can remotely enter SIP, Network, and Address settings and send them on the device to prepare the device for functioning. More details you can read here. 

6. Add access restrictions for created groups/users.

Access restrictions link devices, users, and schedules