DiType User Guide/Administration

From Docs

Jump to: navigation, search

< DiType User Guide

There are a number of administrative tasks that can be performed to provide administrators with further information about the DiType installation and status, and to allow administrators to change the default characteristics of the DiType application.

Controlling the DiType server on http://localhost:19800 The DiType server provides a web interface to monitor and control its activity. Using this interface, it is possible to shutdown, kill, suspend, or resume the DiType server. The monitoring facility provides a table describing each session, including the following information:
  • The host port from which it originated
  • The timing information
  • Whether the formatting session was successful or not
Monitoring the temporary folder The temporary folder is configured in the ditype.conf configuration file. The temporary folder is set to the value of the "temporary-directory" option in the "file-server" service section of the configuration file. The temporary folder is used to store cached external resources and intermediate files. When a formatting session ends, whether it was successful or not, all of the files in the temporary folder that were produced during the formatting session are removed. Thus, normally there is no requirement to manually remove temporary files from the folder. However, when the DiType server is started in debug mode, the files are not removed from the temporary folder. When the DiType server is started in debug mode, an administrator is required to manually clean the temporary folder.
Environment variables The DiType server, the standard applications (DiType Assistant, ActiType and ditype ), and the connectors included in the DiType DevKit are affected by the following environment variables:
  • DITYPE_HOST (default: localhost)
  • DITYPE_DATA_PORT (default: 19790)
  • DITYPE_HTTP_PORT (default: 19800)

These variables, if specified, allow clients to locate a running DiType server to which they are able to connect. The DITYPE_DATA_PORT and DITYPE_HTTP_PORT variables force the server to use the specified ports for data exchange or monitoring.

Starting the server with debug-level logging It is possible to start the DiType server in debug mode. This causes detailed messages to be sent to each session's logger, and in Lisp REPL listening on TCP port 12345 as configured in the ditype.conf configuration file. With debug-level logging turned on, temporary files are not removed. The server will start in debug mode if cliser.py is given the switch -d. Debug mode is incompatible with multiplexing by running several lambda processes.
Firewall-related issues The DiType server communicates data with clients on TCP port 19790 and provides a web interface on TCP port 19800. It uses TCP port 6210 and TCP port 6610 internally for inter-space data exchange and provides a Lisp REPL on TCP port 12345 when in debug mode. The port numbers given here are the default values, they may be altered via environment variables or by changing the relevant value in ditype.conf.
Optimizing performance A number of performance-related options that are present in ditype.conf may alter the performance of the DiType server. These are the options for the "lambda" space, which are set by default to the optimal values.

Contents

Windows

This section describes the administration tasks that can be carried out in a Windows environment.

Files

On Microsoft Windows, the DiType installation creates by default the following files and directories:

  • %ProgramFiles%\RenderX\DiType\Framework

Processes

The following processes are started when the system is rebooted at the last step of the installation process:

  • ditype-service.exe
  • pythonw.exe
  • lambda.exe

Starting Manually

It is possible to start, stop, or restart the DiType server manually from the command line; e.g., after making configuration changes. This can be done with the following command:

net start ditype , or net stop ditype

Whenever the DiType server starts, it first checks if there is an instance of the DiType server already running on the system by checking for the existence of the pid file, which usually is found in /Library/Frameworks/DiType.framework/Common/var/ditype.pid. Upon normal shutdown of the DiType server, the pid file is removed. However, abnormal termination may leave the pid file in place, preventing further startups of the DiType server. If this happens, remove the pid file manually.


Mac OS X

This section describes the administration tasks that can be carried out in a Mac OS X environment.

Files

On Mac OS X, the DiType installation creates the following files and directories:

  • /Library/Frameworks/DiType.framework
  • /Library/Frameworks/GPLGhostscript
  • /Library/StartupItems/DiType
  • /Library/Applications/DiTypeAssistant.app
  • /Library/Applications/ActiType.app
  • /Library/Receipts/ditype-*.pkg
  • /usr/local/bin/ditype

Processes

The following processes are started when the system is rebooted at the last step of the installation process: Note: The output of ps is split into several lines with '\' used as a line separator in order to fit the page width.

/Library/Frameworks/DiType.framework/Versions/1/Common/env/Python.framework/ \
Versions/Current/bin/python \
/Library/Frameworks/DiType.framework/Versions/1/Common/pi/ditype/cliser.py -c \
/Library/Frameworks/DiType.framework/Versions/1/Configuration/ditype.conf

/Library/Frameworks/DiType.framework/Versions/1/Common/lambda \
/tmp/lambda-Yeed3w

The standard GUI applications, DiType Assistant and ActiType, are represented by the following processes:

/Library/Frameworks/DiType.framework/Common/env/Python.framework/Versions/ \
Current/Resources/Python.app/Contents/MacOS/Python actitype.pyw \
--config /Users/msulyaev/.actitype/actitype.conf

/Library/Frameworks/DiType.framework/Common/env/Python.framework/Versions/ \
Current/Resources/Python.app/Contents/MacOS/Python assistant.pyw

Starting Manually

It is possible to start, stop, or restart the DiType server manually from the command line; e.g., after making configuration changes. This can be done with the following command:

/Library/StartupItems/DiType/DiType <action>
where <action> is start , stop , or restart.

Whenever the DiType server starts, it first checks if there is an instance of the DiType server already running on the system by checking for the existence of the pid file, which usually is found in /Library/Frameworks/DiType.framework/Common/var/ditype.pid. Upon normal shutdown of the DiType server, the pid file is removed. However, abnormal termination may leave the pid file in place, preventing further startups of the DiType server. If this happens, remove the pid file manually.


Unix/Linux

This section describes the administration tasks that can be carried out in a Unix/Linux environment.

This chapter is unfinished.



Personal tools