# Sample SchoolTool HTTP server configuration file

# identify the component configuration used to define the site:
site-definition schooltool-skel/etc/site.zcml

#
# school-type
#
# The school type to be used when initializing the database.
#
# Example:
#   school-type lyceum


#
# path /path/to/add
# path /another/path/to/add
#
#  Specifies a path to add to the beginning of Python's module search path
#  There can be zero or more 'path' directives
#

#
# module dotted.module.name
# module another.dotted.module.name
#
#  Lists modules to be set up when the server is started. The modules must
#  provide IModuleSetup. The module 'schooltool.main' is implicitly listed
#  first.
#
# Example:
#   module school.example
#

#
# listen[_ssl] port
# listen[_ssl] interface:port
#
#   DEPRECIATED: The listen directives are depreciated in favour of the rest
#   directives.
#
#   Specifies the port number and optionaly a network interface for
#   the RESTive server to listen on. There can be one or more 'listen'
#   directives. If _ssl is used the server will accept only SSL connctions
#   on that port and a ssl_certificate configuration line is required.
#
# Examples:
#   listen 7001
#   listen 127.0.0.1:80
#   listen_ssl 7002

# listen 7001

#
# web[_ssl] port
# web[_ssl] interface:port
#
#   Specifies the port number and optionaly a network interface for
#   the web application server to listen on. There can be one or more
#   'listen' directives. If _ssl is used the server will accept only
#   SSL connctions on that port and a ssl_certificate configuration
#   line is required.
#
#   Note: SSL is currently un-implemented in the schooltool server.
#
# Examples:
#   web 8080
#   web 127.0.0.1:80
#   web_ssl 8443
#

web 7080

#
# rest port
# rest interface:port
#
#   Specifies the port number and optionaly a network interface for
#   the RESTive application server to listen on
#
# Examples:
#   rest 7001
#   rest 127.0.0.1:7001
#

# rest 7001

#
#
# ssl_certificate certificate
#
#   Specifies a certificate in PEM format which contains a certificate and
#   private key for use in SSL connections.
#   This is required to use listen_ssl
#

#
# thread-pool-size n
#
#   Specifies the suggested size for request thread pool
#
# Default:
#   thread-pool-size 10
#

#
# event-logging on|off
#
#   Enables or disables global event logging to /utils/eventlog
#
# Default:
#   event-logging off
#

#
# pid-file
#
#   Specifies the path of a pid file.
#
# Default: no pidfile
#
pid-file schooltool-skel/var/schooltool.pid

#
# error-log-file
#
#   Specifies the path of a log file used for exceptions. Special
#   values STDERR and STDOUT mean standard error and standard output
#   respectively.
#
#   You can specify more than one log file.  All messages will be duplicated
#   to all the log files.
#
# Default:
#    error-log-file STDERR
#
# Examples:
#    error-log-file /var/log/schooltool/error.log
#    error-log-file STDERR
#
error-log-file schooltool-skel/var/schooltool.log
error-log-file STDERR

#
# rest-access-log-file
#
#   Specifies the path of a file used for an Apache combined format
#   access log for the RESTive API server.  Special values STDERR and
#   STDOUT mean standard error and standard output respectively.
#
#   You can specify more than one log file.  All messages will be duplicated
#   to all the log files.
#
# Default:
#    rest-access-log-file STDOUT
#
# Examples:
#    rest-access-log-file /var/log/schooltool/access.log
#    rest-access-log-file STDOUT
#
rest-access-log-file schooltool-skel/log/rest-access.log

#
# web-access-log-file
#
#   Specifies the path of a file used for an Apache combined format
#   access log of the web application.  Special values STDERR and
#   STDOUT mean standard error and standard output respectively.
#
#   You can specify more than one log file.  All messages will be duplicated
#   to all the log files.
#
# Default:
#    web-access-log-file STDOUT
#
# Examples:
#    web-access-log-file /var/log/schooltool/access.log
#    web-access-log-file STDOUT
#
web-access-log-file schooltool-skel/log/web-access.log

#
# attendance-log-file
#
#   Specifies the path of a log file used for attendance
#   logging. Special values STDERR and STDOUT mean standard error and
#   standard output respectively.
#
#   You can specify more than one log file.  All messages will be duplicated
#   to all the log files.
#
# Default:
#    attendance-log-file var/attendance.log
#
# Examples:
#    attendance-log-file /var/log/schooltool/attendance.log
#    attendance-log-file STDOUT
#
attendance-log-file schooltool-skel/log/attendance.log

#
# lang
#
#   Specifies the locale of the messages to be used on the server.
#
#   If 'auto' is set, the language is chosen according to the user's
#   preference specified in the web browser configuration.
#
# Default:
#   lang auto
#
# Examples:
#   lang en_UK
#   lang fr

#
# domain
#
#   Specifies the name of the message catalog to be used on the server.
#
# Default:
#   domain schooltool
#
# Examples:
#   domain schoolbell

#
# <zodb>
#   ...
# </zodb>
#
#   Specifies a ZODB database to use.
#   This section is required.
#

<zodb>
  # <filestorage>		traditional FileStorage
  #   path filename		required
  #   create yes|no		default: yes
  #   read-only yes|no		default: no
  #   quota size		default: no quota
  # </filestorage>
  <filestorage>
    path schooltool-skel/var/Data.fs
  </filestorage>

  # <mappingstorage>		in-memory MappingStorage
  #   name storage-name		default: Mapping Storage
  # </mappingstorage>

  # <fullstorage>		BerkeleyDB based storage
  #   ...			XXX
  # </fullstorage>

  # <minimalstorage>		BerkeleyDB based storage, stripped down
  #   ...			see <fullstorage>
  # </minimalstorage>

  # <zeoclient>
  #   server address		one or more; required
  #   cache-size n		default: 20000000 (bytes)
  #   name storage-name		default: address of the server
  #   client x			enables persistent cache for client x
  #   var dirname		directory for persistent cache (default: .)
  #   min-disconnect-poll n	default: 5
  #   max-disconnect-poll n	default: 300
  #   wait yes|no		default: yes
  #   read-only yes|no		default: no
  #   read-only-fallback yes|no	default: no
  #   realm name		authentication realm
  # </zeoclient>

  # <demostorage>		currently broken
  #   name			default: Demo Storage
  #   quota			XXX
  #   ...			another section describing base storage
  # </demostorage>

  # cache-size n
  #
  # Default:
  #   cache-size 5000

  # pool-size n
  #
  # Default:
  #   pool-size 7

</zodb>

#
# reportlab_fontdir
#
#   Specifies the path to TrueType fonts (Arial and Times New Roman)
#   for ReportLab.
#
#   Comment out or set to empty string to disable reportlab.
#
# Examples:
#    reportlab_fontdir /usr/share/fonts/truetype/msttcorefonts
#
# Uncomment the following and update the path to enable PDF generation:
#reportlab_fontdir /usr/share/fonts/truetype/msttcorefonts

# devmode
#
#   Switches the Developer Mode on and off.
#
# Default:
#   devmode off
#
#devmode on