Mercurial > defr > drupal > core

comparison INSTALL.txt @ 1:c1f4ac30525a 6.0

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Drupal 6.0
author Franck Deroche <webmaster@defr.org>
date Tue, 23 Dec 2008 14:28:28 +0100
parents
children fff6d4c8c043
comparison
equal deleted inserted replaced
0:5a113a1c4740 1:c1f4ac30525a
1 // $Id: INSTALL.txt,v 1.61.2.2 2008/02/07 20:46:56 goba Exp $
2
3 CONTENTS OF THIS FILE
4 ---------------------
5
6 * Requirements
7 * Optional requirements
8 * Installation
9 * Drupal administration
10 * Customizing your theme(s)
11 * Multisite Configuration
12 * More Information
13
14 REQUIREMENTS
15 ------------
16
17 Drupal requires a web server, PHP 4 (4.3.5 or greater) or PHP 5
18 (http://www.php.net/) and either MySQL (http://www.mysql.com/) or PostgreSQL
19 (http://www.postgresql.org/). The Apache web server and MySQL database are
20 recommended; other web server and database combinations such as IIS and
21 PostgreSQL have been tested to a lesser extent. When using MySQL, version 4.1.1
22 or greater is recommended to assure you can safely transfer the database.
23
24 For more detailed information about Drupal requirements, see "Requirements"
25 (http://drupal.org/requirements) in the Drupal handbook.
26
27 For detailed information on how to configure a test server environment using
28 a variety of operating systems and web servers, see "Local server setup"
29 (http://drupal.org/node/157602) in the Drupal handbook.
30
31 OPTIONAL REQUIREMENTS
32 ---------------------
33
34 - To use XML-based services such as the Blogger API and RSS syndication,
35 you will need PHP's XML extension. This extension is enabled by default.
36
37 - To use Drupal's "Clean URLs" feature on an Apache web server, you will need
38 the mod_rewrite module and the ability to use local .htaccess files. For
39 Clean URLs support on IIS, see "Using Clean URLs with IIS"
40 (http://drupal.org/node/3854) in the Drupal handbook.
41
42 - Various Drupal features require that the web server process (for
43 example, httpd) be able to initiate outbound connections. This is usually
44 possible, but some hosting providers or server configurations forbid such
45 connections. The features that depend on this functionality include the
46 integrated "Update status" module (which downloads information about
47 available updates of Drupal core and any installed contributed modules and
48 themes), the ability to log in via OpenID, fetching aggregator feeds, or
49 other network-dependent services.
50
51
52 INSTALLATION
53 ------------
54
55 1. DOWNLOAD DRUPAL AND OPTIONALLY A TRANSLATION
56
57 You can obtain the latest Drupal release from http://drupal.org/. The files
58 are in .tar.gz format and can be extracted using most compression tools. On a
59 typical Unix command line, use:
60
61 wget http://drupal.org/files/projects/drupal-x.x.tar.gz
62 tar -zxvf drupal-x.x.tar.gz
63
64 This will create a new directory drupal-x.x/ containing all Drupal files
65 and directories. Move the contents of that directory into a directory within
66 your web server's document root or your public HTML directory:
67
68 mv drupal-x.x/* drupal-x.x/.htaccess /var/www/html
69
70 If you would like to have the default English interface translated to a
71 different language, we have good news. You can install and use Drupal in
72 other languages from the start. Check whether a released package of the
73 language desired is available for this Drupal version at
74 http://drupal.org/project/translations and download the package. Extract
75 the contents to the same directory where you extracted Drupal into.
76
77 2. GRANT WRITE PERMISSIONS ON CONFIGURATION FILE
78
79 Drupal comes with a default.settings.php file in the sites/default
80 directory. The installer will create a copy of this file filled with
81 the details you provide through the install process, in the same
82 directory. Give the web server write privileges to the sites/default
83 directory with the command (from the installation directory):
84
85 chmod o+w sites/default
86
87 3. CREATE THE DRUPAL DATABASE
88
89 Drupal requires access to a database in order to be installed. Your database
90 user will need sufficient privileges to run Drupal. Additional information
91 about privileges, and instructions to create a database using the command
92 line are available in INSTALL.mysql.txt (for MySQL) or INSTALL.pgsql.txt
93 (for PostgreSQL).
94
95 To create a database using PHPMyAdmin or a web-based control panel consult
96 the documentation or ask your webhost service provider.
97
98 Take note of the username, password, database name and hostname as you
99 create the database. You will enter these items in the install script.
100
101 4. RUN THE INSTALL SCRIPT
102
103 To run the install script point your browser to the base URL of your website
104 (e.g., http://www.example.com).
105
106 You will be guided through several screens to set up the database,
107 create tables, add the first user account and provide basic web
108 site settings.
109
110 The install script will attempt to create a files storage directory
111 in the default location at sites/default/files (the location of the
112 files directory may be changed after Drupal is installed). In some
113 cases, you may need to create the directory and modify its permissions
114 manually. Use the following commands (from the installation directory)
115 to create the files directory and grant the web server write privileges to it:
116
117 mkdir sites/default/files
118 chmod o+w sites/default/files
119
120 The install script will attempt to write-protect the sites/default
121 directory after creating the settings.php file. If you make manual
122 changes to that file later, be sure to protect it again after making
123 your modifications. Failure to remove write permissions to that file
124 is a security risk. Although the default location for the settings.php
125 file is at sites/default/settings.php, it may be in another location
126 if you use the multi-site setup, as explained below.
127
128 5. CONFIGURE DRUPAL
129
130 When the install script succeeds, you will be directed to the "Welcome"
131 page, and you will be logged in as the administrator already. Proceed with
132 the initial configuration steps suggested on the "Welcome" page.
133
134 If the default Drupal theme is not displaying properly and links on the page
135 result in "Page Not Found" errors, try manually setting the $base_url variable
136 in the settings.php file if not already set. It's currently known that servers
137 running FastCGI can run into problems if the $base_url variable is left
138 commented out (see http://bugs.php.net/bug.php?id=19656).
139
140 6. REVIEW FILE SYSTEM STORAGE SETTINGS AND FILE PERMISSIONS
141
142 The files directory created in step 4 is the default file system path used
143 to store all uploaded files, as well as some temporary files created by Drupal.
144 After installation, the settings for the file system path may be modified
145 to store uploaded files in a different location.
146
147 It is not necessary to modify this path, but you may wish to change it if:
148
149 * your site runs multiple Drupal installations from a single codebase
150 (modify the file system path of each installation to a different
151 directory so that uploads do not overlap between installations); or,
152
153 * your site runs a number of web server front-ends behind a load
154 balancer or reverse proxy (modify the file system path on each
155 server to point to a shared file repository).
156
157 To modify the file system path:
158
159 * Ensure that the new location for the path exists or create it if
160 necessary. To create a new directory named uploads, for example,
161 use the following command from a shell or system prompt (while in
162 the installation directory):
163
164 mkdir uploads
165
166 * Ensure that the new location for the path is writable by the web
167 server process. To grant write permissions for a directory named
168 uploads, you may need to use the following command from a shell
169 or system prompt (while in the installation directory):
170
171 chmod o+w uploads
172
173 * Access the file system path settings in Drupal by selecting these
174 menu items from the Navigation menu:
175
176 Administer > Site configuration > File system
177
178 Enter the path to the new location (e.g.: uploads) at the File
179 System Path prompt.
180
181 Changing the file system path after files have been uploaded may cause
182 unexpected problems on an existing site. If you modify the file system path
183 on an existing site, remember to copy all files from the original location
184 to the new location.
185
186 Some administrators suggest making the documentation files, especially
187 CHANGELOG.txt, non-readable so that the exact version of Drupal you are
188 running is slightly more difficult to determine. If you wish to implement
189 this optional security measure, use the following command from a shell or
190 system prompt (while in the installation directory):
191
192 chmod a-r CHANGELOG.txt
193
194 Note that the example only affects CHANGELOG.txt. To completely hide
195 all documentation files from public view, repeat this command for each of
196 the Drupal documentation files in the installation directory, substituting the
197 name of each file for CHANGELOG.txt in the example.
198
199 For more information on setting file permissions, see "Modifying Linux, Unix,
200 and Mac file permissions" (http://drupal.org/node/202483) or "Modifying
201 Windows file permissions" (http://drupal.org/node/202491) in the online
202 handbook.
203
204 7. CRON MAINTENANCE TASKS
205
206 Many Drupal modules have periodic tasks that must be triggered by a cron
207 maintenance task, including search module (to build and update the index
208 used for keyword searching), aggregator module (to retrieve feeds from other
209 sites), ping module (to notify other sites about new or updated content), and
210 system module (to perform routine maintenance and pruning on system tables).
211 To activate these tasks, call the cron page by visiting
212 http://www.example.com/cron.php, which, in turn, executes tasks on behalf
213 of installed modules.
214
215 Most systems support the crontab utility for scheduling tasks like this. The
216 following example crontab line will activate the cron tasks automatically on
217 the hour:
218
219 0 * * * * wget -O - -q -t 1 http://www.example.com/cron.php
220
221 More information about cron maintenance tasks are available in the help pages
222 and in Drupal's online handbook at http://drupal.org/cron. Example scripts can
223 be found in the scripts/ directory.
224
225 DRUPAL ADMINISTRATION
226 ---------------------
227
228 A new installation of Drupal defaults to a very basic configuration with only a
229 few active modules and minimal user access rights.
230
231 Use your administration panel to enable and configure services. For example:
232
233 General Settings Administer > Site configuration > Site information
234 Enable Modules Administer > Site building > Modules
235 Configure Themes Administer > Site building > Themes
236 Set User Permissions Administer > User management > Permissions
237
238 For more information on configuration options, read the instructions which
239 accompany the different configuration settings and consult the various help
240 pages available in the administration panel.
241
242 Community-contributed modules and themes are available at http://drupal.org/.
243
244 CUSTOMIZING YOUR THEME(S)
245 -------------------------
246
247 Now that your installation is running, you will want to customize the look of
248 your site. Several sample themes are included and more can be downloaded from
249 drupal.org.
250
251 Simple customization of your theme can be done using only CSS. Further changes
252 require understanding the phptemplate engine that is part of Drupal. See
253 http://drupal.org/handbook/customization to find out more.
254
255 MULTISITE CONFIGURATION
256 -----------------------
257
258 A single Drupal installation can host several Drupal-powered sites, each with
259 its own individual configuration.
260
261 Additional site configurations are created in subdirectories within the 'sites'
262 directory. Each subdirectory must have a 'settings.php' file which specifies the
263 configuration settings. The easiest way to create additional sites is to copy
264 the 'default' directory and modify the 'settings.php' file as appropriate. The
265 new directory name is constructed from the site's URL. The configuration for
266 www.example.com could be in 'sites/example.com/settings.php' (note that 'www.'
267 should be omitted if users can access your site at http://example.com/).
268
269 Sites do not have to have a different domain. You can also use subdomains and
270 subdirectories for Drupal sites. For example, example.com, sub.example.com,
271 and sub.example.com/site3 can all be defined as independent Drupal sites. The
272 setup for a configuration such as this would look like the following:
273
274 sites/default/settings.php
275 sites/example.com/settings.php
276 sites/sub.example.com/settings.php
277 sites/sub.example.com.site3/settings.php
278
279 When searching for a site configuration (for example www.sub.example.com/site3),
280 Drupal will search for configuration files in the following order, using the
281 first configuration it finds:
282
283 sites/www.sub.example.com.site3/settings.php
284 sites/sub.example.com.site3/settings.php
285 sites/example.com.site3/settings.php
286 sites/www.sub.example.com/settings.php
287 sites/sub.example.com/settings.php
288 sites/example.com/settings.php
289 sites/default/settings.php
290
291 If you are installing on a non-standard port, the port number is treated as the
292 deepest subdomain. For example: http://www.example.com:8080/ could be loaded
293 from sites/8080.www.example.com/. The port number will be removed according to
294 the pattern above if no port-specific configuration is found, just like a real
295 subdomain.
296
297 Each site configuration can have its own site-specific modules and themes in
298 addition to those installed in the standard 'modules' and 'themes' directories.
299 To use site-specific modules or themes, simply create a 'modules' or 'themes'
300 directory within the site configuration directory. For example, if
301 sub.example.com has a custom theme and a custom module that should not be
302 accessible to other sites, the setup would look like this:
303
304 sites/sub.example.com/:
305 settings.php
306 themes/custom_theme
307 modules/custom_module
308
309 NOTE: for more information about multiple virtual hosts or the configuration
310 settings, consult the Drupal handbook at drupal.org.
311
312 For more information on configuring Drupal's file system path in a multi-site
313 configuration, see step 6 above.
314
315 MORE INFORMATION
316 ----------------
317
318 - For additional documentation, see the online Drupal handbook at
319 http://drupal.org/handbook.
320
321 - For a list of security announcements, see the "Security announcements" page
322 at http://drupal.org/security (available as an RSS feed). This page also
323 describes how to subscribe to these announcements via e-mail.
324
325 - For information about the Drupal security process, or to find out how to report
326 a potential security issue to the Drupal security team, see the "Security team"
327 page at http://drupal.org/security-team.
328
329 - For information about the wide range of available support options, see the
330 "Support" page at http://drupal.org/support.