libki client installation - Libki/libki-client GitHub Wiki

Libki Kiosk Management System Client

[ Linux ]

  • NOTE: To have an operational client, you must have a working libki server setup and its details.

In order to use the libki client on Linux, you must compile it from source. If created on a 64bit machine, it will not work with a 32bit machine and vice versa.

Compilation:

Install required packages.

sudo apt-add-repository ppa:ubuntu-sdk-team/ppa
sudo apt-get update
sudo apt-get install git build-essential qtcreator qt5-default qttools5-dev-tools libqt5webkit5-dev libqt5script5 qtscript5-dev

Download a copy of the libki client source.

git clone https://github.com/Libki/libki-client.git
  • Open Qt Creator, then select “Open File or Project” from the file menu.
  • Select the “Libki.pro” file in the source folder you have just downloaded.
  • Select “Build Project Libki” from the build menu.

Installation:

  • Copy the “libkiclient” file from the debug folder that was created in the same directory as the libkiclient source folder to your home directory.

  • Copy the libki client /usr/local/bin

sudo cp libkiclient /usr/local/bin
  • Make the file executable.
sudo chmod +x /usr/local/bin/libkiclient
  • Copy the settings file.
cp libki-client/example.ini .config/Libki.ini
  • Set it up to your liking. If you wish to use another text editor than nano, open the file manually. It's location is .config/Libki.ini.
nano .config/Libki.ini
  • NOTE: Set no_passwords=1 to no_passwords=0 if you have password authentication.

Starting on Login:

There are a number of ways to approach this. Some are reflective of the environment libki is being run from.

  • By adding Libki to the list of startup programs. This is dependent of your desktop environment.
    • XFCE: navigate to the system settings. Then select “Sessions and Startup”, “Application Autostart”. Press the “+” key, add the name, description and location of the libki client (“/usr/local/bin/libkiclient”).
    • Unity
    • GNOME
    • MATE should be the same as GNOME shell.
    • KDE
  • Set the program to run on login. One way is to create a .desktop file for the program in the autostart directory ($HOME/.config/autostart).

[ Windows ]

Installation:

  • NOTE: To have an operational client, you must have a working libki server setup and its details.
  1. Login to the intended user you want to install libki for. My advice is to create a standard user, not an administrator as users could cause trouble with elevated permissions.
  2. Download the latest version of the compiled client. It should be available in the downloads page of the libkiclient bitbucket. As of writing its: https://bitbucket.org/libki-kms/libki-client/downloads/Libki_Client_2.0.1.0_(13.11_Fry)_Installer.exe (NOTE: this is out of date, here is the list of installers)
  3. Run the installer executable. Make sure it is being run as an administrator. It will prompt you to enter the administrator password and possibly the user name (not the current users password).
  4. Press “Next” after the welcome screen.
  5. Enter the client name and the client location.
  • The client name should be unique to the machine. This way you can identify it via the administration panel.
  • The client location can also be used to aid identification of machines, however it can be blank if you only have one location using the server.
  • Scheme should be http
  1. The installer will prompt you to enter the server address and the server port. The address refers to the IP of the server (This could be an external IP address if the appropriate port forwarding is in place, but you would probably want to restrict the traffic by source IP to prevent everyone on the internet accessing your Libki server). On most Linux servers, you should be able to determine the local IP using the “ifconfig” command, if you do not have a static IP address set you should do that, otherwise you'll probably find your clients cannot find the server after a power outage causes your server to get a new IP address from DHCP. The server port refers to the port the libkiserver is listening on. By default it was 8080, but now appears to be 3000. Press “Next” when you are done.
  • NOTE: You can confirm the address by navigating to the server address and the port separated by a colon in your web browser i.e. 192.168.1.10:3000. If it returns the libki web page, those are the right values.
  1. This page will ask for the libki install location. Program files should be fine for the majority of users. Press “Next” when you are done.
  2. The next screen will show you the install location, and ask you to confirm the install. Press “Install” to start the installation.
  3. The installer will complete and a check-box will be selected. This check-box is for a desktop locker password. A desktop locker password allows you to unlock libki and access the desktop with the key combination “ctrl + alt + shift + l”. Keep it selected if you want to enable this. (this option doesn't appear to exist anymore)
  4. Press “Finish”. The installer will close, and a prompt will pop up allowing for a password to be entered. This password should be something unique and not obvious. Keep in mind this is not a substitute for other forms of protection for the machine. This password is used to unlock the Libki client in the event that it cannot access the server to authenticate actual users.
  5. You should have a working client!
  6. Login to Windows, and you should see the Libki login page come up. Login to test. (You will need to have created a user already on the Libki server, using the administration pages!)

Libki should start automatically on boot.

NOTE: The administration pages can be accessed by adding /administration to the Libki server URL, so you would have something like this:

http://192.168.1.10/administration

...where 192.168.1.10 is the IP address of your libki server.

Program Options

There are more options available by editing the file C:\ProgramData\Libki\Libki Kiosk Management System.ini (NOTE: C:\ProgramData is a hidden system folder) as administrator. It's easy accessed by typing in %AppData% in the directory bar in Explorer.

  • The host IP seems to need to be in double quotes

  • The port should be 3000

  • The schema needs to be "http" (in double quotes)

  • node

    • name - The name to display on the server for this client

    • logoutAction - Options are:

      • no_action - Just display the login screen again. I don't know if this closes any running programs. If not, it's not a good option!
      • logout - Logout of the current Widows session, back to the Welcome screen (good for Deep freeze, because it will then reboot, but you'll probably want to set Windows to auto login to the desired user using netplwzd.
      • reboot - Reboot the client machine, also good for Deep Freeze, if it's not set to reboot on logout itself.

    • no_passwords - 1 for on, 0 for off. Turning this on just hides the password field; if your users have passwords then they will not be able to login!

    • onlyStopFor - Display Libki when any user other than those listed here login to Windows.

    • onlyRunFor - Display Libki when any of these users login to Windows.

      • I don't know what the delimiter is. I would try space, then comma.

    • location - The value that will display in the location field for this client. Can be anything, including blank if you only have one location.

    • password - The hashed (or encrypted?) password for bypassing the Libki login screen (this is very useful when the Libki server is not available, but will not help if you have no_passwords enabled.

    • username - Don't know what options there are for this. Mine is set to: Username or library card number

  • labels

    • username - The text to display for the Username field.
    • password - The text to display for the Password field.

  • Save the file with UTF-8 encoding if you're using non-ASCII characters (i.e. å, ä, ö or another character outside a-z).

By Christopher Vella Commissioned by "Calyx":http://www.calyx.net.au !http://www.calyx.net.au/media/calyx-logo-opac.png(Calyx Logo)!