Configuration Options
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 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.
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 below.
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 settings for the settings above are stored in the telstar.yaml configuration file which is stored in the /opt/telstar directory of the respective container. 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.
TELSTAR_API_HOST
This is for future use and can be ignored the default setting is:
0.0.0.0
TELSTAR_PAD_HOST
This is for future use and can be ignored the default setting is:
0.0.0.0
TELSTAR_PAD_DLE
This is the Data Link Escape character used to exit a Gateway connection, the default value is:
0x10 (Ctrl P)
TELSTAR_SERVER_HOST
This is for future use and can be ignored the default setting is:
0.0.0.0
TELSTAR_SERVER_DISPLAY_NAME
This is the display name of the viewdata server and is used in place of the [SERVER] placeholder tag, see Frames for more details on placeholder tags. The default value is:
DUKE
TELSTAR_HIDE_PAGE_ID
Setting this value to true will hide the Page ID displayed in the top line header of the frame. The default value is:
FALSE
TELSTAR_HIDE_COST
Setting this value to true will hide the frame cost displayed in the top line header of the frame. The default value is:
FALSE
TELSTAR_DISABLE_VERTICAL_ROLLOVER
Setting this value to true will enable Vertical Rollover. The default value is:
TRUE
Vertical Rollover is used as a means for Telstar to move the cursor to a point on the screen in the most efficient way possible. For example to get to the start of the bottom row, it may be quicker to send the commands HOME followed by VT. This would cause a vertical rollover to the bottom row. Not all clients currently support this correctly.
TELSTAR_EDITTF_TITLE_ROWS
The https://edit.tf frame editor can be used to create pages and titles. When used to create a title, the number of rows taken fron the edit.tf data can be specified with this variable. The default settings is:
4
TELSTAR_DBCON
This is the database connection and points to a mongo Docker container on the Docker telstar-network, see Installing Telstar. The default value is:
mongodb://mongoadmin:secret@telstar-mongo:27017
TELSTAR_DBCOLLECTION
The database is divided into two logical partitions, PRIMARY and SECONDARY. Typically PRIMARY would be used for a production system with SECONDARY being used for a test system. When adding pages to the database via the API, these would typically be send to the SECONDARY database, reviewed on a test system and then published to the PRIMARY database. The default value is:
SECONDARY
TELSTAR_START_PAGE
The start poage to be used by the system. This would typically be a welcome screen. The default vale is:
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