Skip to content

Latest commit

 

History

History
executable file
·
127 lines (89 loc) · 3.57 KB

server-startup.md

File metadata and controls

executable file
·
127 lines (89 loc) · 3.57 KB
Raw

Starting TabPy Server

These instructions explain how to start up TabPy Server.

Prerequisites

To start up TabPy Server from an environment the following prerequisites are required:

  • Python 3.6.5
  • setuptools (Python module, can be installed from PyPi)

First, select a TabPy version and download its source code from the releases page. To start up a TabPy server instance, follow the instructions for your OS (found below).

Instructions on how to configure your TabPy server instance can be found in the TabPy Server Configuration Instructions

It is highly recommended to use Python virtual enviroment for running TabPy. Check the Running TabPy in Python Virtual Environment page for more details. If you are installing a newer version of TabPy in the same environment as a previous install, delete the previous TabPy version folder in your Python directory.

Windows

  1. Open a command prompt.

  2. Navigate to the folder in which you downloaded your source code.

    • This folder should contain the file: startup.cmd

  3. Run the following command from the command prompt:

    startup.cmd

Command Line Arguments for Windows

To specify the config file with which to configure your server instance, pass it in as a command line argument as follows:

startup.cmd myconfig.conf

Replace myconfig.conf with the path to your config file relative to %TABPY_ROOT%\tabpy-server\tabpy_server\.

For example, in this case your config file would be located at %TABPY_ROOT%\tabpy-server\tabpy_server\myconfig.conf.

Mac

  1. Open a terminal.

  2. Navigate to the folder in which you downloaded your source code.

    • This folder should contain the file: startup.sh

  3. Run the following command from the terminal:

    ./startup.sh

Command Line Arguments for Mac

  • To specify the config file with which to configure your server instance, set the --config=* or -c=* command line argument as follows:

    ./startup.sh --config=myconfig.conf

    or

    ./startup.sh -c=myconfig.conf

    Replace myconfig.conf with the path to your config file relative to $TABPY_ROOT/tabpy-server/tabpy_server/.

    For example, in this case your config file would be located at $TABPY_ROOT/tabpy-server/tabpy_server/myconfig.conf.

Linux

  1. Open a terminal.

  2. Navigate to the folder in which you downloaded your source code.

    • This folder should contain the file: startup.sh

  3. Run the following command from the terminal:

    ./startup.sh

Command Line Arguments for Linux

  • To specify the config file with which to configure your server instance, set the --config=* or -c=* command line argument as follows:

    ./startup.sh --config=myconfig.conf

    or

    ./startup.sh -c=myconfig.conf

    Replace myconfig.conf with the path to your config file relative to $TABPY_ROOT/tabpy-server/tabpy_server/.

    For example, in this case your config file would be located at $TABPY_ROOT/tabpy-server/tabpy_server/myconfig.conf.