API reference

API reference for Ocsigen Server. See the manual to get started.

• Ocsigen.Server

Extensions

• Staticmod Staticmod: serve static files
• Extendconfiguration Extendconfiguration: More configuration options for Ocsigen Server
• Accesscontrol Accesscontrol: Conditional access to some sites
• Authbasic Authbasic: Basic HTTP authentication
• Deflatemod Deflatemod: compress output data
• Redirectmod Redirectmod: HTTP redirections
• Revproxy Revproxy: Forward a request to another Web server
• Rewritemod Rewrite: Change the request
• Outputfilter Outputfilter: Rewrite some part of the output
• Securityheaders Securityheaders: add common security-related response headers
• Userconf
• Cors Cross-Origin Resource Sharing

Requests and responses

• Ocsigen.Request
• Ocsigen.Response
• Ocsigen.Multipart
• Ocsigen_cookie_map
• Ocsigen_http.Charset_mime

Persistent data, writing in the logs, configuration file extension, polymorphic tables

• Ocsigen_base.Lib This module contains some auxiliaries for the Ocsigenserver. In contrast to Ocsigen_lib_base, the function may also refer to libraries other than the standard library.
• Ocsigen.Messages Writing messages in the logs
• Ocsigen.Parseconfig Config file parsing. See also module Extensions.​Configuration
• Polytables Polymorphic tables (using Map)
• Ocsigen_base.Cache Cache. Association tables (from any kind of database) that keep the most recently used values in memory. It is also possible to set a maximum lifetime for data in the cache.
• Ocsigen.Config Configuring Ocsigen server

Extending Ocsigen Server

• Ocsigen.Extensions Extensions interface for Ocsigen Server
• Ocsigen.Local_files
• Ocsigen_http.Header
• Ocsigen_base.Ocsigen_stream
• Ocsigen_base.Loader Module Loader: Dynamic loading for Ocsigen.
• Ocsigen.Command Extending server commands