"SfR Fresh" - the SfR Freeware/Shareware Archive 
Member "ocs-2.1.0-1/docs/README" of archive ocs-2.1.0-1.tar.gz:
As a special service "SfR Fresh" has tried to format the requested source page into HTML format using source code syntax highlighting with prefixed line numbers.
Alternatively you can here view or download the uninterpreted source code file.
That can be also achieved for any archive member file by clicking within an archive contents listing on the first character of the file(path) respectively on the according byte size field.
1 ================================
2 === Open Conference Systems
3 === The Public Knowledge Project
4 === Version: 2.1.0-1
5 === CVS tag: ocs-2_1_0-1
6 === Release date: May 23, 2008
7 ================================
8
9
10 About
11 -----
12 Open Conference Systems (OCS) has been developed by the Public Knowledge
13 Project. For general information about OCS and other open research systems,
14 visit the PKP web site at <http://pkp.sfu.ca/>.
15
16
17 License
18 -------
19 OCS is licensed under the GNU General Public License v2. See the file
20 docs/COPYING for the complete terms of this license.
21
22 Third parties are welcome to modify and redistribute OCS in entirety or parts
23 according to the terms of this license. PKP also welcomes patches for
24 improvements or bug fixes to the software.
25
26
27 System Requirements
28 -------------------
29 Recommended server requirements:
30
31 * PHP >= 4.2.x (including PHP 5.x); Microsoft IIS requires PHP 5.x
32 * MySQL >= 3.23.23 (including MySQL 4.x) or PostgreSQL >= 7.1
33 (including PostgreSQL 8.x)
34 * Apache >= 1.3.2x or >= 2.0.4x or Microsoft IIS 6
35 * Operating system: Any OS that supports the above software, including
36 Linux, BSD, Solaris, Mac OS X, Windows
37
38 As PKP does not have the resources to test every possible combination of
39 software versions and platforms, no guarantee of correct operation or support
40 is implied. We welcome feedback from users who have deployed OCS on systems
41 other than those listed above.
42
43
44 Recommended Configuration
45 -------------------------
46
47 A secure deployment can be best achieved by using the following policies:
48
49 * Dedicate a database to OCS; use unique credentials to access it.
50 Configure this database to perform automated backups on a regular
51 basis. Perform a manual backup when upgrading or performing
52 maintenance.
53
54 * Configure OCS (config.inc.php) to use SHA1 hashing rather than MD5.
55
56 * Configure OCS (config.inc.php) to use force_ssl_login so that
57 authenticated users communicate with the server via HTTPS.
58
59 * Install OCS so that the files directory is NOT a subdirectory of
60 the OCS installation and cannot be accessed directly via the web
61 server. Restrict file permissions as much as possible. Automated
62 backups of this directory should be roughly synchronized with
63 database backups.
64
65
66 Installation
67 ------------
68 Please review this document and the RELEASE document prior to installing OCS.
69 If you encounter problems, please also see the FAQ document in this directory.
70
71 To install OCS:
72
73 1. Extract the OCS archive to the desired location in your web documents
74 directory.
75
76 2. Make the following files and directories (and their contents)
77 writeable (i.e., by changing the owner or permissions with chown or
78 chmod):
79
80 * config.inc.php (optional -- if not writable you will be prompted
81 to manually overwrite this file during installation)
82 * public
83 * cache
84 * cache/t_cache
85 * cache/t_config
86 * cache/t_compile
87 * cache/_db
88
89 3. Create a directory to store uploaded files (submission files, etc.)
90 and make this directory writeable. It is recommended that this
91 directory be placed in a non-web-accessible location (or otherwise
92 protected from direct access, such as via .htaccess rules).
93
94 4. Open a web browser to <http://yourdomain.com/path/to/ocs/> and follow
95 the on-screen installation instructions.
96
97 Alternatively, the command-line installer can be used instead by
98 running the command "php tools/install.php" from your OCS directory.
99 (Note: with the CLI installer you may need to chown/chmod the public
100 and uploaded files directories after installation, if the Apache user
101 is different from the user running the tool.)
102
103 The installer also offers a "manual installation" option that will
104 display the SQL statements necessary to create the OCS database but
105 not execute them.
106
107 5. Recommended additional steps post-installation:
108
109 * Review config.inc.php for additional configuration settings
110 * Review the FAQ document for frequently asked technical and
111 server configuration questions.
112
113
114 Upgrading
115 ---------
116 See docs/UPGRADE for information on upgrading from previous OCS 1.x and OCS 2.x
117 releases.
118
119
120 Localization
121 ------------
122 To add support for other languages, the following sets of XML files must be
123 localized and placed in an appropriately named directory (using ISO locale
124 codes, e.g. "fr_FR", is recommended):
125
126 * locale/en_US
127 * dbscripts/xml/data/locale/en_US
128 * help/en_US
129 * registry/locale/en_US
130 * rt/en_US
131 * plugins/[plugin category]/[plugin name]/locale, where applicable
132
133 The only critical files that need translation for the system to function
134 properly are found in locale/en_US, dbscripts/xml/data/locale/en_US, and
135 registry/locale/en_US.
136
137 New locales must also be added to the file registry/locales.xml, after which
138 they can be installed in the system through the site administration web
139 interface.
140
141 Translations can be contributed back to PKP for distribution with future
142 releases of OCS.
143
144 Server requirements for full Unicode (UTF-8) support:
145
146 * MySQL >= 4.1.1 or PostgreSQL >= 7.1
147 * PHP >= 4.3.0 compiled with support for the mbstring library
148
149
150 Scheduled Tasks
151 ---------------
152 OCS supports a mechanism to execute a variety of tasks at scheduled times
153 (such as automatic sending of reminder notification emails).
154
155 To enable support for using scheduled tasks, edit your config.inc.php and
156 set the scheduled_tasks setting to On, and set up your operating system to
157 periodically execute (as the same user your webserver is running under) the
158 PHP script found at tools/runScheduledTasks.php in your OCS directory:
159
160 On *nix operating systems, this can be done by adding a simple cron task:
161 # crontab -e www
162 0 * * * * php /path/to/ocs2/tools/runScheduledTasks.php
163 In this example the script would be executed every hour.
164
165 On Windows XP systems, this can be done by using the Windows Task Scheduler:
166 1) From the Control Panel, double-click on Scheduled Tasks.
167 2) Right-click within the Scheduled Tasks window and choose:
168 New > Scheduled Task
169 3) Under the Task tab, in the Run field, enter:
170 php c:\path\to\ocs2\tools\runScheduledTasks.php
171 4) You will also be asked to specify the folder to start this task in
172 (which will usually be the folder that PHP was installed into) and
173 the user under which the task will be executed as.
174 5) Under Schedule tab and the Settings tab, you can more specifically
175 configure the task. For example, you can choose start and end dates
176 for this scheduled task and also how often to execute this task.
177
178 If using the scheduled tasks script, it is recommended that the script be
179 set up to execute at least once per day.
180
181 Note that using the script also requires you to have the PHP command-line
182 interpreter installed on your server.
183
184
185 Third-party Libraries
186 ---------------------
187 * See lib/libraries.txt for a list of third-party libaries used by OCS.
188
189
190 Contact/Support
191 ---------------
192 The forum is the recommended method of contacting the team with technical
193 issues.
194
195 Forum: <http://pkp.sfu.ca/support/forum/>
196 Bugs: <http://pkp.sfu.ca/bugzilla/>
197 Email: <pkp-support@sfu.ca>