Configuration Options

== Configuration Options

__*** Please note TELSTAR as an application is still under development and subject to change. ***__

=== Container Types

The same Telstar image is used to host different container types, for example a the Telstar image can be used to create videotex server container and an API server container. The first argument passed to the container determines the specific configuration of the container. Currently the container supports the following values;

   server          Creates the standard videotex server container
   api             Creates an API server allowing the videotex system to be managed using a restful API.

For example the following Docker run command starts a videotex server listening on port 6502 (see TCP Port below) with an initial set of example system pages.

   docker run --rm -d --name telstar-server --network telstar-network -p 6512:6512 -v telstar-volume:/opt/telstar/volume johnnewcombe/telstar server --port=6502 --init
   

=== TCP Port Number

The _--port-- argument must be specified for the Telstar _server_ and Telstar _api_ containers. The _port_ parameter specifies the TCP port number that the server or api application should be listening on. This can be any suitable port.

1. 1. Optional Arguments

The following is a list of optional arguments for both the Telstar _server_ and Telstar _api_ containers.

   --init                              This will create/recreate the basic telstar content.

The _--init_ parameter, when starting a videotex server will create/recreate the standard telstar system pages along with some example gateway pages. If this parameter is used when starting an API server, it will create an API user using the userid __"2222222222"__ and password __"1234"__.

=== Environment Variables

The full description of each of these can be found in the __telstar.yml__ configuration file.

   Name                                   | Default
   -----------------------------------------------------------------------------------------
   TELSTAR_API_HOST                       | 0.0.0.0
   TELSTAR_PAD_HOST                       | 0.0.0.0
   TELSTAR_PAD_DLE                        | 0x10

TELSTAR_SERVER_HOST | 0.0.0.0 TELSTAR_SERVER_DISPLAY_NAME | DUKE TELSTAR_HIDE_PAGE_ID | FALSE TELSTAR_HIDE_COST | FALSE TELSTAR_DISABLE_VERTICAL_ROLLOVER | TRUE TELSTAR_EDITTF_TITLE_ROWS | 4

   TELSTAR_DBCON                          | mongodb://mongoadmin:secret@telstar-mongo:27017
   TELSTAR_DBCOLLECTION                   | SECONDARY
   TELSTAR_START_PAGE                     | 99
   TELSTAR_LOGIN_PAGE                     | 990
   TELSTAR_MAIN_INDEX_PAGE                | 0
   TELSTAR_REQUIRES_AUTHENTICATION        | FALSE
   TELSTAR_ROOT_USER_ID                   | 0
   TELSTAR_PARITY                         | FALSE
   TELSTAR_VOLUME_DIRECTORY               | /opt/telstar/volume/
   TELSTAR_DEFAULT_NAV_MESSAGE            | [B][n][Y]Select item or[W]*page# : [_+]
   TELSTAR_DEFAULT_PAGE_NOT_FOUND_MESSAGE | [B][n][Y]Page not Found :[W]
   TELSTAR_DEFAULT_HEADER_TEXT            | [G]T[R]E[C]L[B]S[W]T[M]A[Y]R

The default connection string is: "mongodb://mongoadmin:secret@telstar-mongo:27017" and points to a mongo Docker container on the Docker telstar-network, see [Docker Compose](docker_compose.md). The default settings for many of the settings above are stored in the **telstar.yaml** configuration file which is stored in the **/opt/telstar** directory. It is recommended that Telstar is run in a Docker container in which case the above environment variables should be used to override the standard configuration file.