TrueConf

# Accessing and Installing the SDK

The source codes of TrueConf Mobile SDK for mobile applications are located in a remote repository, access to which is restricted and granted by the TrueConf sales department upon your request. In the repository, besides the SDK itself, you will find examples of full-featured applications using the SDK to demonstrate its capabilities.

Below, we will provide detailed instructions on how to access and connect to the repository.

# Step 1. Install Git

We use the Git version control system, so you will need to install software to work with it. Detailed installation instructions for different operating systems can be found on the Git website git-scm.com.

# Step 2. Generate an SSH key

As mentioned above, access to the repository is restricted. Git's standard tool, the SSH key, is used for user identification and to grant access.

Such a key is generated by the user and consists of two parts—public and private (stored in two separate files). You provide us with the public part of the key, while you keep the private part on your computer in the special .ssh directory. Git will handle the rest. To generate the key, enter the following command in your OS terminal:

ssh-keygen

We recommend using the default folder suggested for installation:

  • on Windows OS C:\Users\MyUser\.ssh

  • on Linux /home/MyUser/.ssh

  • on macOS /Users/MyUser/.ssh

where MyUser is your operating system username.

# Step 3. Request a trial period for using the SDK from the sales department

Once the key is generated, contact the sales department to request access to the Git repository. Access to the Android libraries also requires login and password credentials for the Maven repository.

The sales department may inquire about the purposes for which you intend to use the SDK. Please try to describe your project in detail—if we find it interesting, we will provide you with a dedicated technical specialist during the testing period.

Once the sales department decides to grant you access, send them the public part of your key (the file with the .pub extension located in the directory where the generated key was stored).

# Step 4. Download the repository

To clone the repository to your computer, execute the following command in your OS terminal:

git clone git@git.trueconf.ru:SDK TARGET_PATH

where TARGET_PATH is the path to the directory where you want to copy it.

For example, on Linux, the command might look like this:

git clone git@git.trueconf.ru:SDK /home/user/mobile-sdk

If TARGET_PATH is not specified, the repository will be downloaded to the current directory (from which the console is operating).

You can learn about the additional parameters of the git clone command on the Git website - https://git-scm.com/docs/git-clone (opens new window)

To avoid working with the console, you can use Git GUI clients with a user-friendly interface, such as:

When cloning, use git@git.trueconf.ru:SDK as the external repository address.

← Technical Requirements and Installation →