Index: INSTALL.txt =================================================================== RCS file: /cvs/drupal/drupal/INSTALL.txt,v retrieving revision 1.80 diff -u -r1.80 INSTALL.txt --- INSTALL.txt 30 Apr 2010 08:09:21 -0000 1.80 +++ INSTALL.txt 22 Jul 2010 17:11:27 -0000 @@ -3,24 +3,24 @@ CONTENTS OF THIS FILE --------------------- - * Requirements - * Optional tasks - * Installation - * Drupal administration - * Customizing your theme(s) - * Multisite configuration - * More information +- Requirements +- Optional tasks +- Installation +- Drupal administration +- Customizing your theme(s) +- Multisite configuration +- More information REQUIREMENTS ------------ Drupal requires: - - a web server, Apache (version 2.0 or greater) is recommended, - - PHP 5 (5.2.0 or greater) (http://www.php.net/), - - and either MySQL (5.0.15 or greater) (http://www.mysql.com/), PostgreSQL (8.3 - or greater) (http://www.postgresql.org/), or SQLite (3.4.2 or greater) - (http://www.sqlite.org/). +- A web server, Apache (version 2.0 or greater) is recommended, +- PHP 5 (5.2.0 or greater) (http://www.php.net/), +- Either MySQL (5.0.15 or greater) (http://www.mysql.com/), PostgreSQL (8.3 or + greater) (http://www.postgresql.org/), or SQLite (3.4.2 or greater) + (http://www.sqlite.org/). For more detailed information about Drupal requirements, including a list of PHP extensions and configurations that are required, see "System requirements" @@ -33,22 +33,21 @@ OPTIONAL TASKS -------------- -- To use XML-based services such as the Blogger API and RSS syndication, - you will need PHP's XML extension. This extension is enabled by default. +- To use XML-based services such as the Blogger API and RSS syndication, you + will need PHP's XML extension. This extension is enabled by default. - To use Drupal's "Clean URLs" feature on an Apache web server, you will need the mod_rewrite module and the ability to use local .htaccess files. For - Clean URLs support on IIS, see "Using Clean URLs with IIS" - (http://drupal.org/node/3854) in the Drupal handbook. + information on how to set up Clean URLs on various versions of Apache, IIS, + and other web servers, see http://drupal.org/getting-started/clean-urls -- Various Drupal features require that the web server process (for - example, httpd) be able to initiate outbound connections. This is usually - possible, but some hosting providers or server configurations forbid such - connections. The features that depend on this functionality include the - integrated "Update status" module (which downloads information about - available updates of Drupal core and any installed contributed modules and - themes), the ability to log in via OpenID, fetching aggregator feeds, or - other network-dependent services. +- Various Drupal features require that the web server process (for example, + httpd) be able to initiate outbound connections. This is usually possible, but + some hosting providers or server configurations forbid such connections. The + features that depend on this functionality include the integrated "Update + status" module (which downloads information about available updates of Drupal + core and any installed contributed modules and themes), the ability to log in + via OpenID, fetching aggregator feeds, or other network-dependent services. INSTALLATION @@ -63,9 +62,9 @@ wget http://drupal.org/files/projects/drupal-x.x.tar.gz tar -zxvf drupal-x.x.tar.gz - This will create a new directory drupal-x.x/ containing all Drupal files - and directories. Move the contents of that directory into a directory within - your web server's document root or your public HTML directory: + This will create a new directory drupal-x.x/ containing all Drupal files and + directories. Move the contents of that directory into a directory within your + web server's document root or your public HTML directory: mv drupal-x.x/* drupal-x.x/.htaccess /var/www/html @@ -73,19 +72,19 @@ different language, we have good news. You can install and use Drupal in other languages from the start. Check whether a released package of the language desired is available for this Drupal version at - http://drupal.org/project/translations and download the package. Extract - the contents to the same directory where you extracted Drupal into. + http://drupal.org/project/translations and download the package. Extract the + contents to the same directory where you extracted Drupal into. 2. CREATE THE CONFIGURATION FILE AND GRANT WRITE PERMISSIONS Drupal comes with a default.settings.php file in the sites/default - directory. The installer uses this file as a template to create your - settings file using the details you provide through the install process. - To avoid problems when upgrading, Drupal is not packaged with an actual - settings file. You must create a file named settings.php. You may do so - by making a copy of default.settings.php (or create an empty file with - this name in the same directory). For example, (from the installation - directory) make a copy of the default.settings.php file with the command: + directory. The installer uses this file as a template to create your settings + file using the details you provide through the install process. To avoid + problems when upgrading, Drupal is not packaged with an actual settings + file. You must create a file named settings.php. You may do so by making a + copy of default.settings.php (or create an empty file with this name in the + same directory). For example, (from the installation directory) make a copy + of the default.settings.php file with the command: cp sites/default/default.settings.php sites/default/settings.php @@ -94,9 +93,9 @@ chmod o+w sites/default/settings.php - So that the files directory can be created automatically, give the web server - write privileges to the sites/default directory with the command (from the - installation directory): + So that the files directory can be created automatically, give the web server + write privileges to the sites/default directory with the command (from the + installation directory): chmod o+w sites/default @@ -105,31 +104,30 @@ Drupal requires access to a database in order to be installed. Your database user will need sufficient privileges to run Drupal. Additional information about privileges, and instructions to create a database using the command - line are available in INSTALL.mysql.txt (for MySQL) or INSTALL.pgsql.txt - (for PostgreSQL). + line are available in INSTALL.mysql.txt (for MySQL) or INSTALL.pgsql.txt (for + PostgreSQL). To create a database using PHPMyAdmin or a web-based control panel consult the documentation or ask your webhost service provider. - Take note of the username, password, database name and hostname as you - create the database. You will enter these items in the install script. + Take note of the username, password, database name and hostname as you create + the database. You will enter these items in the install script. 4. RUN THE INSTALL SCRIPT To run the install script point your browser to the base URL of your website (e.g., http://www.example.com). - You will be guided through several screens to set up the database, - create tables, add the site maintenance account (the first user, also known - as user/1), and provide basic web site settings. - - The install script will attempt to create a files storage directory - in the default location at sites/default/files (the location of the - files directory may be changed after Drupal is installed). In some - cases, you may need to create the directory and modify its permissions - manually. Use the following commands (from the installation directory) - to create the public and private files directories and grant the web server - write privileges to them: + You will be guided through several screens to set up the database, create + tables, add the site maintenance account (the first user, also known as + user/1), and provide basic web site settings. + + The install script will attempt to create a files storage directory in the + default location at sites/default/files (the location of the files directory + may be changed after Drupal is installed). In some cases, you may need to + create the directory and modify its permissions manually. Use the following + commands (from the installation directory) to create the public and private + files directories and grant the web server write privileges to them: mkdir sites/default/files chmod o+w sites/default/files @@ -137,9 +135,9 @@ chmod o+w sites/default/private The install script will attempt to write-protect the settings.php file and - the sites/default directory after saving your configuration. However, you - may need to manually write-protect them using the commands (from the - installation directory): + the sites/default directory after saving your configuration. However, you may + need to manually write-protect them using the commands (from the installation + directory): chmod a-w sites/default/settings.php chmod a-w sites/default @@ -147,66 +145,66 @@ If you make manual changes to the file later, be sure to protect it again after making your modifications. Failure to remove write permissions to that file is a security risk. Although the default location for the settings.php - file is at sites/default/settings.php, it may be in another location - if you use the multi-site setup, as explained below. + file is at sites/default/settings.php, it may be in another location if you + use the multi-site setup, as explained below. 5. CONFIGURE DRUPAL - When the install script succeeds, you will be directed to the "Welcome" - page logged in with the site maintenance account. Proceed with the initial + When the install script succeeds, you will be directed to the "Welcome" page + logged in with the site maintenance account. Proceed with the initial configuration steps suggested on the "Welcome" page. If the default Drupal theme is not displaying properly and links on the page - result in "Page Not Found" errors, try manually setting the $base_url variable - in the settings.php file if not already set. It's currently known that servers - running FastCGI can run into problems if the $base_url variable is left - commented out (see http://bugs.php.net/bug.php?id=19656). + result in "Page Not Found" errors, try manually setting the $base_url + variable in the settings.php file if not already set. It's currently known + that servers running FastCGI can run into problems if the $base_url variable + is left commented out (see http://bugs.php.net/bug.php?id=19656). 6. REVIEW FILE SYSTEM STORAGE SETTINGS AND FILE PERMISSIONS - The files directory created in step 4 is the default file system path used - to store all uploaded files, as well as some temporary files created by Drupal. - After installation, the settings for the file system path may be modified - to store uploaded files in a different location. + The files directory created in step 4 is the default file system path used to + store all uploaded files, as well as some temporary files created by Drupal. + After installation, the settings for the file system path may be modified to + store uploaded files in a different location. It is not necessary to modify this path, but you may wish to change it if: - * your site runs multiple Drupal installations from a single codebase - (modify the file system path of each installation to a different - directory so that uploads do not overlap between installations); or, - - * your site runs a number of web server front-ends behind a load - balancer or reverse proxy (modify the file system path on each - server to point to a shared file repository). + - Your site runs multiple Drupal installations from a single codebase (modify + the file system path of each installation to a different directory so that + uploads do not overlap between installations); or, + + - Your site runs a number of web server front-ends behind a load balancer or + reverse proxy (modify the file system path on each server to point to a + shared file repository). To modify the file system path: - * Ensure that the new location for the path exists or create it if - necessary. To create a new directory named uploads, for example, - use the following command from a shell or system prompt (while in - the installation directory): + - Ensure that the new location for the path exists or create it if + necessary. To create a new directory named uploads, for example, use the + following command from a shell or system prompt (while in the installation + directory): - mkdir uploads + mkdir uploads - * Ensure that the new location for the path is writable by the web - server process. To grant write permissions for a directory named - uploads, you may need to use the following command from a shell - or system prompt (while in the installation directory): + - Ensure that the new location for the path is writable by the web server + process. To grant write permissions for a directory named uploads, you may + need to use the following command from a shell or system prompt (while in + the installation directory): - chmod o+w uploads + chmod o+w uploads - * Access the file system path settings in Drupal by selecting these - menu items from the Navigation menu: + - Access the file system path settings in Drupal by selecting these menu + items from the Navigation menu: - Administer > Site configuration > File system + Administer > Configuration > Media > File system - Enter the path to the new location (e.g.: uploads) at the File - System Path prompt. + Enter the path to the new location (e.g.: uploads) at the File System Path + prompt. Changing the file system path after files have been uploaded may cause unexpected problems on an existing site. If you modify the file system path - on an existing site, remember to copy all files from the original location - to the new location. + on an existing site, remember to copy all files from the original location to + the new location. Some administrators suggest making the documentation files, especially CHANGELOG.txt, non-readable so that the exact version of Drupal you are @@ -214,11 +212,11 @@ this optional security measure, use the following command from a shell or system prompt (while in the installation directory): - chmod a-r CHANGELOG.txt + chmod a-r CHANGELOG.txt - Note that the example only affects CHANGELOG.txt. To completely hide - all documentation files from public view, repeat this command for each of - the Drupal documentation files in the installation directory, substituting the + Note that the example only affects CHANGELOG.txt. To completely hide all + documentation files from public view, repeat this command for each of the + Drupal documentation files in the installation directory, substituting the name of each file for CHANGELOG.txt in the example. For more information on setting file permissions, see "Modifying Linux, Unix, @@ -229,8 +227,8 @@ 7. CRON MAINTENANCE TASKS Many Drupal modules have periodic tasks that must be triggered by a cron - maintenance task, including search module (to build and update the index - used for keyword searching), aggregator module (to retrieve feeds from other + maintenance task, including search module (to build and update the index used + for keyword searching), aggregator module (to retrieve feeds from other sites), and system module (to perform routine maintenance and pruning on system tables). @@ -238,17 +236,18 @@ Note, however, that cron tasks will only be executed when there are site visitors. You can enable the built-in cron feature at: - Administer > Configuration > System > Site information + Administer > Configuration > System > Site information Advanced users may want to ensure that cron tasks are executed periodically. To do this, visit the page "cron.php", which executes maintenance tasks on behalf of installed modules. The URL of the cron.php page requires a "cron key" to protect against unauthorized access. + Each cron key is automatically generated during installation and is specific to your site. The full URL of the page, with cron key, is available in the "Cron maintenance tasks" section of the "Status report page" at: - Administer > Reports > Status report + Administer > Reports > Status report Most systems support using a crontab utility for automatically executing tasks like visiting the cron.php page. The following example crontab line @@ -261,18 +260,18 @@ "Status report" page. More information about cron maintenance tasks are available in the help pages - and in Drupal's online handbook at http://drupal.org/cron. Example cron scripts - can be found in the scripts/ directory. (Note that these scripts must be - customized similar to the above example, to add your site-specific cron key - and domain name.) + and in Drupal's online handbook at http://drupal.org/cron. Example cron + scripts can be found in the scripts/ directory. (Note that these scripts must + be customized similar to the above example, to add your site-specific cron + key and domain name.) BUILDING AND CUSTOMIZING YOUR SITE ---------------------------------- A new installation of Drupal defaults to a very basic configuration with only a -few active modules and minimal user access rights. When extending your site, -you use "modules" and "themes". A module is a plugin that adds functionallity to +few active modules and minimal user access rights. When extending your site, you +use "modules" and "themes". A module is a plugin that adds functionallity to Drupal, while a theme changes the front-end look and behavior of your site. It is important to install these correctly and not mix them in with the core @@ -297,8 +296,7 @@ Later on you might want to write your own code, but remember to NEVER modify the core modules and themes in Drupal directories modules and themes. Instead use the hooks available in the Drupal API. You can read more about the Drupal API -and how to develop modules at -http://drupal.org/developing/modules +and how to develop modules at http://drupal.org/developing/modules MULTISITE CONFIGURATION @@ -316,9 +314,9 @@ should be omitted if users can access your site at http://example.com/). Sites do not have to have a different domain. You can also use subdomains and -subdirectories for Drupal sites. For example, example.com, sub.example.com, -and sub.example.com/site3 can all be defined as independent Drupal sites. The -setup for a configuration such as this would look like the following: +subdirectories for Drupal sites. For example, example.com, sub.example.com, and +sub.example.com/site3 can all be defined as independent Drupal sites. The setup +for a configuration such as this would look like the following: sites/default/settings.php sites/example.com/settings.php @@ -371,9 +369,9 @@ at http://drupal.org/security (available as an RSS feed). This page also describes how to subscribe to these announcements via e-mail. -- For information about the Drupal security process, or to find out how to report - a potential security issue to the Drupal security team, see the "Security team" - page at http://drupal.org/security-team. +- For information about the Drupal security process, or to find out how to + report a potential security issue to the Drupal security team, see the + "Security team" page at http://drupal.org/security-team. - For information about the wide range of available support options, see the "Support" page at http://drupal.org/support.