Cross-platform computer monitoring and classroom management
Clone or download

README.md

Veyon - Virtual Eye On Networks

Build status Latest stable release Overall downloads on Github Documentation Status Localise on Transifex license

What is Veyon?

Veyon is a free and Open Source software for computer monitoring and classroom management supporting Windows and Linux. It enables teachers to view and control computer labs and interact with students. Veyon is available in different languages and provides lots of useful features:

  • see what's going on in computer labs in overview mode and take screenshots
  • remote control computers to support and help users
  • broadcast teacher's screen to students in realtime by using demo mode (either in fullscreen or in a window)
  • lock workstations for attracting attention to teacher
  • send text messages to students
  • powering on/off and rebooting computers remote
  • remote logoff and remote execution of arbitrary commands/scripts
  • home schooling - Veyon's network technology is not restricted to a subnet and therefore students at home can join lessons via VPN connections just by installing the Veyon service

License

Copyright (c) 2004-2018 Tobias Junghans / Veyon Solutions.

See the file COPYING for the GNU GENERAL PUBLIC LICENSE.

Installation and configuration

Please refer to the official Veyon Administrator Manual at http://docs.veyon.io/en/latest/admin/index.html for information on the installation and configuration of Veyon.

Usage

Please refer to the official Veyon User Manual at http://docs.veyon.io/en/latest/user/index.html for information on how to use Veyon.

Veyon on Linux

Downloading sources

First grab the latest sources by cloning the Git repository and fetching all submodules:

git clone --recursive https://github.com/veyon/veyon.git && cd veyon

Installing dependencies

Requirements for Debian-based distributions:

  • Build tools: g++ make cmake
  • Qt5: qtbase5-dev qtbase5-dev-tools qttools5-dev qttools5-dev-tools
  • X11: xorg-dev libxtst-dev
  • libjpeg: libjpeg-dev provided by libjpeg-turbo8-dev or libjpeg62-turbo-dev
  • zlib: zlib1g-dev
  • OpenSSL: libssl-dev
  • PAM: libpam0g-dev
  • procps: libprocps-dev
  • LZO: liblzo2-dev
  • QCA: libqca2-dev libqca-qt5-2-dev
  • LDAP: libldap2-dev

As root you can run

apt install g++ make cmake qtbase5-dev qtbase5-dev-tools qttools5-dev qttools5-dev-tools \
            xorg-dev libxtst-dev libjpeg-dev zlib1g-dev libssl-dev libpam0g-dev \
            libprocps-dev liblzo2-dev libqca2-dev libqca-qt5-2-dev libldap2-dev

Requirements for RedHat-based distributions:

  • Build tools: gcc-c++ make cmake rpm-build
  • Qt5: qt5-devel
  • X11: libXtst-devel libXrandr-devel libXinerama-devel libXcursor-devel libXrandr-devel libXdamage-devel libXcomposite-devel libXfixes-devel
  • libjpeg: libjpeg-turbo-devel
  • zlib: zlib-devel
  • OpenSSL: openssl-devel
  • PAM: pam-devel
  • procps: procps-devel
  • LZO: lzo-devel
  • QCA: qca-devel qca-qt5-devel
  • LDAP: openldap-devel

As root you can run

dnf install gcc-c++ make cmake rpm-build qt5-devel libXtst-devel libXrandr-devel libXinerama-devel libXcursor-devel \
         libXrandr-devel libXdamage-devel libXcomposite-devel libXfixes-devel libjpeg-turbo-devel zlib-devel \
         openssl-devel pam-devel procps-devel lzo-devel qca-devel qca-qt5-devel openldap-devel

Configuring and building sources

Run the following commands:

mkdir build
cd build
cmake ..
make -j4

NOTE: If you want to build a .deb or .rpm package for this software, instead of the provided cmake command, you should use:

cmake -DCMAKE_INSTALL_PREFIX=/usr ..

to install package files in /usr instead of /usr/local.

If some requirements are not fullfilled, CMake will inform you about it and you will have to install the missing software before continuing.

You can now generate a package (.deb or .rpm depending what system you are in).

For generating a package you can run

fakeroot make package

Then you'll get something like veyon_x.y.z_arch.deb or veyon-x.y.z.arch.rpm

Alternatively you can install the built binaries directly (not recommended for production systems) by running the following command as root:

make install

Arch linux

A PKGBUILD can be found in the AUR.

PPA

This PPA contains official Veyon packages for Ubuntu suitable for use both on desktop computers and ARM boards (e.g. Raspberry Pi). Even though only packages for LTS releases are available they should work for subsequent non-LTS releases as well.

sudo add-apt-repository ppa:veyon/stable
sudo apt-get update

Join development

If you are interested in Veyon, its programming, artwork, testing or something like that, you're welcome to participate in the development of Veyon!

Before starting the implementation of a new feature, please always open an issue at https://github.com/veyon/veyon/issues to start a discussion about your intended implementation. There may be different ideas, improvements, hints or maybe an already ongoing work on this feature.

More information