Installation and getting started¶
To install ViXeN, you first need to know the platform you will be running it on. ViXeN binaries are available for Linux (64 bit), Mac (64 bit), and Windows (32 and 64 bit). You can install ViXeN in a Python environment easily too but this is not necessary if you do not use Python.
In order to use ViXeN you will need to have a working browser. See the Dependencies section for more information on the dependencies. Installing ViXeN is relatively straight-forward. Please see the instructions for installing ViXeN in the relevant sections below.
On GNU/Linux systems one may install the dependencies by following three very simple steps:
- Download the Linux binary from the ViXeN releases.
- Unpack the
- Run the application inside the unpacked directory.
More detailed instructions are given below.
- Download the ViXen binary file (say vixen-1.0-linux64.tgz) from ViXeN releases to your preferred directory.
- Right click and select ‘Extract Here’ or ‘Open With Archive Manager’. A
ViXeN folder will appear in the directory you have selected (in this case
the folder will be
- Open the directory and double click the
ViXeNfile (the file is
ViXeN.desktop). The ViXeN application will open on the browser.
- If the above did not work you can try to run the
vixenfile. This will run if Nautilus supports running executables. If it does not, run the command shown in Using the Command Line.
Using the Command Line¶
After downloading and unpacking ViXen either Using Nautilus, run the following commands on the terminal:
$ cd vixen-1.0
vixen-1.0 is the extracted ViXeN binary. Suppose you downloaded and
vixen-1.0-linux64.tgz file in a folder named
home directory, then this command will be:
$ cd Software/vixen-1.0
Then run the application using:
- On OS X, download the ZIP file from the ViXeN releases page.
- Unpack it.
- Run the resulting
ViXeN.dmgfile by double clicking it.
You may move this dmg file anywhere you like or move it to your
Applications folder if you wish to.
- On Windows, download the ZIP file for your platform from ViXeN releases.
- Unpack the ZIP file.
- Inside the unpacked directory is a
vixen.batscript or a
vixen.lnkshortcut that you can use to run the application.
The application will open in your default browser window.
If you have no idea what pip is, then you should look above for suitable instructions. If you are familiar with Python and wish to install ViXeN in your own Python environment, you can simply run:
$ pip install vixen
The requirements for ViXeN are fairly modest.
Otherwise, if you wish to install the development version, you can clone the ViXeN git repository at https://github.com/vixen-project/vixen and then do the following:
$ cd vixen $ pip install -r requirements.txt $ python setup.py install
If you want to stay up-to-date and not have to re-install each time you update the git repository, you could instead do:
$ python setup.py develop
Once installed you can start the application by:
To see any command line options try this:
$ vixen -h
That’s about it.
If the application fails to run or you have any problems, please look at the
vixen.log located inside the
.vixen folder in your home
- On Linux this is typically in the directory
- On OS X this is in
- On Windows this may be
The log file should also be accessible once the ViXeN UI launches, it is available on the top bar next to the “Home” and “Help” links on the top left.
The log file is a text file and if you see any sensitive information there, you can feel free to edit it before you send it.
You may e-mail your log file to the developers or the mailing list.
The ViXeN mailing list is available at https://groups.google.com/d/forum/vixen