Rev 61 | Details | Compare with Previous | Last modification | View Log | RSS feed
| Rev | Author | Line No. | Line |
|---|---|---|---|
| 61 | magnus | 1 | .\" -*- nroff -*- |
| 2 | .Dd 17 August 2008 |
||
| 3 | .Os "The Prayer Webmail Interface" |
||
| 4 | .ds volume-operating-system |
||
| 5 | .Dt PRAYER 8 |
||
| 6 | .Sh NAME |
||
| 7 | .Nm prayer |
||
| 8 | .Nd standalone IMAP-based webmail server |
||
| 9 | .Sh SYNOPSIS |
||
| 10 | .Nm |
||
| 11 | .Oo Fl -config-file |
||
| 12 | .Ar file Oc |
||
| 13 | .Oo Oo Fl -config-option |
||
| 14 | .Ar name Ns = Ns Ar value Oc |
||
| 15 | .Ar ... Oc |
||
| 16 | .Op Fl -foreground | -disable-prefork |
||
| 17 | .Oo Fl -disable-session | - |
||
| 18 | .Ar session-options Ar ... Oc |
||
| 19 | . |
||
| 20 | .Sh DESCRIPTION |
||
| 21 | .Nm |
||
| 22 | is the normal frontend daemon in the Prayer Webmail system. It is a |
||
| 23 | simple HTTP server and proxy that serves icons and other static files, |
||
| 24 | but firstly and foremostly forwards requests to the correct backend |
||
| 25 | daemons based on session IDs passed either in cookies or as part of |
||
| 26 | the URL. |
||
| 27 | .Pp |
||
| 28 | The master daemon normally preforks a number of child processes that |
||
| 29 | each will serve a configurable number of requests. The total number of |
||
| 30 | child processes is limited to prevent denial of service attacks. |
||
| 31 | .Pp |
||
| 32 | .Nm |
||
| 33 | accepts the following command-line options: |
||
| 34 | .Bl -tag -width indent |
||
| 35 | .It Fl -config-file Ar file |
||
| 36 | Reads configuration from |
||
| 37 | .Ar file |
||
| 38 | instead of the default. |
||
| 39 | .It Fl -config-option Ar name Ns = Ns Ar value |
||
| 40 | Sets (overrides) the configuration option |
||
| 41 | .Ar name No to Ar value . |
||
| 42 | Any number of options can be specified in this manner. |
||
| 43 | .It Fl -foreground |
||
| 44 | Debug mode. Run a single process in the foreground. |
||
| 45 | .It Fl -disable-prefork |
||
| 46 | Disable preforking. The master daemon will listen for connections |
||
| 47 | on the configured ports and spawn child processes one at a time. |
||
| 48 | .It Fl -disable-session |
||
| 49 | Do not start the session server, |
||
| 50 | .Xr prayer-session 8 . |
||
| 51 | .It Fl - |
||
| 52 | End of |
||
| 53 | .Nm |
||
| 54 | options; remaining options will be passed to |
||
| 55 | .Xr prayer-session 8 . |
||
| 56 | .El |
||
| 57 | . |
||
| 58 | .Sh ENVIRONMENT |
||
| 59 | . |
||
| 60 | .Bl -tag -width ".Ev PRAYER_CONFIG_FILE " |
||
| 61 | .It Ev PRAYER_CONFIG_FILE |
||
| 62 | Can be set to specify the configuration file to use. |
||
| 63 | .It Ev PRAYER_HOSTNAME |
||
| 64 | Local hostname. Overrides the |
||
| 65 | .Cd hostname |
||
| 66 | setting in the configuration file as well as on the command line. |
||
| 67 | .El |
||
| 68 | . |
||
| 69 | .Sh FILES |
||
| 70 | . |
||
| 71 | .Bl -tag -compact |
||
| 72 | .It Pa /etc/prayer/prayer.cf |
||
| 73 | Default configuration file. |
||
| 74 | .It Pa /usr/share/prayer/icons/ |
||
| 75 | Location of the standard icons used by the interface. |
||
| 76 | .It Pa /usr/share/prayer/static/ |
||
| 77 | Directory containing other static files; currently only CSS files. |
||
| 78 | .It Pa /var/run/prayer/sockets/ |
||
| 79 | Pre-configured location of sockets for frontend to backend communication. |
||
| 80 | .El |
||
| 81 | . |
||
| 82 | .Sh SEE ALSO |
||
| 83 | . |
||
| 84 | .Xr prayer-session 8 , |
||
| 85 | .Xr prayer.cf 5 |
||
| 86 | . |
||
| 87 | .Sh AUTHORS |
||
| 88 | . |
||
| 89 | This manual page was put together by |
||
| 90 | .An -nosplit |
||
| 91 | .An "Magnus Holmgren" <holmgren@debian.org> |
||
| 92 | .No using documentation written by An "David Carter" <dpc22@cam.ac.uk> . |
||
| 93 | .\" .Sh BUGS |