Manual browser: daportal.conf(5)
daportal.conf — Configuration file for DaPortal
daportal.conf file should be found within the root
folder of an installation of the DaPortal project. A sample file should
already be available when extracting DaPortal.
daportal.conf file is organized in sections, each
containing a number of variables. Section names are written on their own
line, between brackets (eg "[section]"). Variables are given on their own
lines too, like this:
The daportal.conf file may be commented, comment lines being prepended with a hash sign "#".
Variables can be defined directly without specifying a particular section first; they belong then to the default section, which is simply considered to have an empty name.
The daportal.conf file typically starts with the following variables:
debug: whether to log debugging information (each engine may have its own implementation for logging)
PREFIXdirectory where the required system files are installed, like translations (defaults to
theme: the default theme (defaults to "DaPortal")
title: the default title (defaults to "DaPortal")
A number of sections are essential for proper configuration of DaPortal. Most map to a specific subsystem of DaPortal, as summarized here:
defaults: a few important additional values can be set within this section.
engine: the default engine can be set within this section, through the
backendvariable (default: auto-detected)
auth: the default authentication subsystem can be set within this section, through the
backendvariable (default: determined by the engine)
database: the database backend can be forced within this section, through the
backendvariable as well (default: SQLite 3)
format: the default file format to use when converting pages for delivery to the user; specific backends can be forced for any given MIME type, and variables can be set per backend (defaults: specific to each engine and format backend)
template: the default templating engine to use when generating pages, through the
backendvariable (default: basic, when not overriden by the engine).
The list of variables available for each of these sections is specific to each; they are typically listed within the default configuration file.
The other sections typically match a particular module or subsystem, with the name composed of two parts:
the type of subsystem (eg "database", "engine", "format", "module", "template"...) followed by two colons "::";
the name of the subsystem affected.
Again, the list of variables available for each of these sections is found within the default configuration file.
This subsystem is responsible for proper authentication of the final user. Different authentication mechanisms are necessary or relevant depending on the current environment, and therefore provided by this subsystem. User-specific storage should also be provided by this subsystem, as it may be required by some other subsystems or modules for proper operation.
The database subsystem is in charge of interacting with the actual database backend to be used. It must handle SQL prepared statements, and should implement transactions as well.
The format subsystem converts input in the DaPortal's internal widget-based representation to the desired output format, which can range from a native application window to document formats, as well as plain text.
The actual format backend to be used is usually determined by the
engine, according to the MIME type expected; the
configuration file can be used to map these associations (as illustrated in
the section called “Sample file”).
The templating subsystem is optional, and may be loaded to enrich the content returned by specific requests, or determine whether and how the results of additional requests should be rendered as well.
The "admin" module is reserved to site administrators, and manages which modules are to be enabled.
The "content" module is an abstract class, dedicated to content management. It is, in turn, inherited by more specialized modules (such as "news", "blog", "wiki"...) which format and authorize access to content according to their respective requirements.
A sample configuration file is provided here.
debug=1 theme=DaPortal title=DaPortal [defaults] charset=utf-8 [engine] #backend=cli backend=http [database] backend=pgsql debug=0 [database::pgsql] #username= #password= #database= #hostname= #port= #timeout= #service= [format] backend=html5 [format::html5] alternate_themes=1 [format::text/html] backend=html5 [format::text/plain] #backend=plain backend=html5 [template] backend=basic [template::basic] footer=All rights reserved
Issues can be listed and reported at http://www.defora.org/os/project/bug_list/12/DaPortal.