Skip to main content

Installation

Enterprise IT

If you want to use VIKTOR within an enterprise IT environment, please make sure that your machine meets all requirements. See the enterprise IT guide for more information. Please contact your IT department to verify that your machine meets all requirements.

If your machine does not meet all requirements you can consider using a remote development environment.

In this guide, you will find everything you need to get started with VIKTOR.

Prerequisites

Before you get started, you're going to need a few things:

  • A machine that runs on Windows or Linux.
  • Python 3.7 - 3.10 (64-bit) installed and added to PATH
  • Your favorite Integrated Development Environment (IDE). For example, PyCharm
  • A VIKTOR account, which you can create for free here.

Install the VIKTOR CLI

Estimated time: 15 min

The VIKTOR command-line interface (CLI) is a tool required to start and publish your VIKTOR apps. Download the installer below, open it, and follow the instructions on the screen.


note

The installer will automatically add the installation directory of the CLI to the PATH variable, which means that you will be able to use the CLI from any directory!

Configure the CLI

Next you'll need to set up the CLI. For this step you will need to open a command-line shell.

In the start menu search bar, type "command prompt" and select the app:

tip

You can enable copy-pasting with Ctrl+C / Ctrl+V in Windows' Command Prompt by deselecting "Use legacy console" and selecting "Enable Ctrl key shortcuts" in the Properties menu (right-click title bar, choose "Properties"). Furthermore, we recommend to deselect "QuickEdit Mode" to prevent locking the command-line by accident, causing running apps to hang.

Enter the following command on the command-line:

viktor-cli configure

The configure command opens a prompt that guides you through the configuration process. You will need to enter the following information:

  1. Development environment. This is the environment that you will use while developing VIKTOR apps. The correct development environment is also stated in the invitation email you received when your account was created.
    • Free users: cloud.viktor.ai
    • Paid users: {company}.viktor.ai (substitute {company} with the name of your company)
  2. Email address used to create your VIKTOR account.
  3. Personal token. You can generate a token by logging in to your development environment. If you are logging in for the first time, use the link from the activation mail to generate a password to log in to the development environment. Alternatively, you can click "Forgot Password" to receive a mail to (re)set your password. Go to the settings page by clicking the three dots next to your name in the top-right corner and after that clicking 'Settings'. Select the 'Developer Account' tab and click the 'Generate new token' button. Copy the token and paste it in the command-line shell.
  4. Select the default isolation mode venv (virtual environment) by pressing enter.
  5. Enter the path to your Python installation. If Python has been added to the PATH environment variable it will be inserted as a suggestion, select it by pressing enter.
tip

You can see a list of all CLI commands by entering

viktor-cli --help

Run the system check

Just to be sure, run the following command to verify the installation:

viktor-cli check-system

The check-system command performs several checks. If everything went right, you should see the following at the end of the message:

V Your system is ready to use VIKTOR with isolation mode 'venv'

Make sure that you see a "V" in front of the message.

note

If any of the system checks fails, additional information can be printed to the command-line by using the --verbose flag:

viktor-cli check-system --verbose

If you have troubles finding the cause of the problem, please consult the FAQ, or leave a message on our Community Forum.