diff options
Diffstat (limited to 'user_guide_src/source/installation')
31 files changed, 1697 insertions, 0 deletions
diff --git a/user_guide_src/source/installation/downloads.rst b/user_guide_src/source/installation/downloads.rst new file mode 100644 index 000000000..45a8f80a7 --- /dev/null +++ b/user_guide_src/source/installation/downloads.rst @@ -0,0 +1,75 @@ +####################### +Downloading CodeIgniter +####################### + +- `CodeIgniter V 3.0.0 (Current + version) <http://codeigniter.com/downloads/>`_ +- `CodeIgniter V + 2.1.2 <http://codeigniter.com/download_files/reactor/CodeIgniter_2.1.2.zip>`_ +- `CodeIgniter V + 2.1.1 <http://codeigniter.com/download_files/reactor/CodeIgniter_2.1.1.zip>`_ +- `CodeIgniter V + 2.1.0 <http://codeigniter.com/download_files/reactor/CodeIgniter_2.1.0.zip>`_ +- `CodeIgniter V + 2.0.3 <http://codeigniter.com/download_files/reactor/CodeIgniter_2.0.3.zip>`_ +- `CodeIgniter V + 2.0.2 <http://codeigniter.com/download_files/reactor/CodeIgniter_2.0.2.zip>`_ +- `CodeIgniter V + 2.0.1 <http://codeigniter.com/download_files/reactor/CodeIgniter_2.0.1.zip>`_ +- `CodeIgniter V + 2.0.0 <http://codeigniter.com/download_files/reactor/CodeIgniter_2.0.0.zip>`_ +- `CodeIgniter V + 1.7.3 <http://codeigniter.com/download_files/CodeIgniter_1.7.3.zip>`_ +- `CodeIgniter V + 1.7.2 <http://codeigniter.com/download_files/CodeIgniter_1.7.2.zip>`_ +- `CodeIgniter V + 1.7.1 <http://codeigniter.com/download_files/CodeIgniter_1.7.1.zip>`_ +- `CodeIgniter V + 1.7.0 <http://codeigniter.com/download_files/CodeIgniter_1.7.0.zip>`_ +- `CodeIgniter V + 1.6.3 <http://codeigniter.com/download_files/CodeIgniter_1.6.3.zip>`_ +- `CodeIgniter V + 1.6.2 <http://codeigniter.com/download_files/CodeIgniter_1.6.2.zip>`_ +- `CodeIgniter V + 1.6.1 <http://codeigniter.com/download_files/CodeIgniter_1.6.1.zip>`_ +- `CodeIgniter V + 1.6.0 <http://codeigniter.com/download_files/CodeIgniter_1.6.0.zip>`_ +- `CodeIgniter V + 1.5.4 <http://codeigniter.com/download_files/CodeIgniter_1.5.4.zip>`_ +- `CodeIgniter V + 1.5.3 <http://codeigniter.com/download_files/CodeIgniter_1.5.3.zip>`_ +- `CodeIgniter V + 1.5.2 <http://codeigniter.com/download_files/CodeIgniter_1.5.2.zip>`_ +- `CodeIgniter V + 1.5.1 <http://codeigniter.com/download_files/CodeIgniter_1.5.1.zip>`_ +- `CodeIgniter V + 1.4.1 <http://codeigniter.com/download_files/CodeIgniter_1.4.1.zip>`_ +- `CodeIgniter V + 1.3.3 <http://codeigniter.com/download_files/CodeIgniter_1.3.3.zip>`_ +- `CodeIgniter V + 1.3.2 <http://codeigniter.com/download_files/CodeIgniter_1.3.2.zip>`_ +- `CodeIgniter V + 1.3.1 <http://codeigniter.com/download_files/CodeIgniter_1.3.1.zip>`_ +- `CodeIgniter V + 1.3 <http://codeigniter.com/download_files/CodeIgniter_1.3.zip>`_ +- `CodeIgniter V + 1.2 <http://codeigniter.com/download_files/CodeIgniter_1.2.zip>`_ +- `CodeIgniter V + 1.1 <http://codeigniter.com/download_files/CodeIgniter_1.1b.zip>`_ +- `CodeIgniter V + 1.0 <http://codeigniter.com/download_files/CodeIgniter_1.0b.zip>`_ + + +****** +GitHub +****** + +`Git <http://git-scm.com/about>`_ is a distributed version control system. + +Public Git access is available at `GitHub <https://github.com/EllisLab/CodeIgniter>`_. +Please note that while every effort is made to keep this code base +functional, we cannot guarantee the functionality of code taken from +the develop branch. + +Beginning with version 2.0.3, stable tags are also available via GitHub, +simply select the version from the Tags dropdown.
\ No newline at end of file diff --git a/user_guide_src/source/installation/index.rst b/user_guide_src/source/installation/index.rst new file mode 100644 index 000000000..7f75f7867 --- /dev/null +++ b/user_guide_src/source/installation/index.rst @@ -0,0 +1,54 @@ +######################### +Installation Instructions +######################### + +CodeIgniter is installed in four steps: + +#. Unzip the package. +#. Upload the CodeIgniter folders and files to your server. Normally the + index.php file will be at your root. +#. Open the application/config/config.php file with a text editor and + set your base URL. If you intend to use encryption or sessions, set + your encryption key. +#. If you intend to use a database, open the + application/config/database.php file with a text editor and set your + database settings. + +If you wish to increase security by hiding the location of your +CodeIgniter files you can rename the system and application folders to +something more private. If you do rename them, you must open your main +index.php file and set the $system_path and $application_folder +variables at the top of the file with the new name you've chosen. + +For the best security, both the system and any application folders +should be placed above web root so that they are not directly accessible +via a browser. By default, .htaccess files are included in each folder +to help prevent direct access, but it is best to remove them from public +access entirely in case the web server configuration changes or doesn't +abide by the .htaccess. + +If you would like to keep your views public it is also possible to move +the views folder out of your application folder. + +After moving them, open your main index.php file and set the +$system_path, $application_folder and $view_folder variables, +preferably with a full path, e.g. '/www/MyUser/system'. + +One additional measure to take in production environments is to disable +PHP error reporting and any other development-only functionality. In +CodeIgniter, this can be done by setting the ENVIRONMENT constant, which +is more fully described on the :doc:`security +page <../general/security>`. + +That's it! + +If you're new to CodeIgniter, please read the :doc:`Getting +Started <../overview/getting_started>` section of the User Guide +to begin learning how to build dynamic PHP applications. Enjoy! + +.. toctree:: + :glob: + :hidden: + :titlesonly: + + *
\ No newline at end of file diff --git a/user_guide_src/source/installation/troubleshooting.rst b/user_guide_src/source/installation/troubleshooting.rst new file mode 100644 index 000000000..0dfd4083f --- /dev/null +++ b/user_guide_src/source/installation/troubleshooting.rst @@ -0,0 +1,19 @@ +############### +Troubleshooting +############### + +If you find that no matter what you put in your URL only your default +page is loading, it might be that your server does not support the +PATH_INFO variable needed to serve search-engine friendly URLs. As a +first step, open your application/config/config.php file and look for +the URI Protocol information. It will recommend that you try a couple +alternate settings. If it still doesn't work after you've tried this +you'll need to force CodeIgniter to add a question mark to your URLs. To +do this open your application/config/config.php file and change this:: + + $config['index_page'] = "index.php"; + +To this:: + + $config['index_page'] = "index.php?"; + diff --git a/user_guide_src/source/installation/upgrade_120.rst b/user_guide_src/source/installation/upgrade_120.rst new file mode 100644 index 000000000..76c510d66 --- /dev/null +++ b/user_guide_src/source/installation/upgrade_120.rst @@ -0,0 +1,20 @@ +#################################### +Upgrading From Beta 1.0 to Final 1.2 +#################################### + +To upgrade to Version 1.2 please replace the following directories with +the new versions: + +.. note:: If you have any custom developed files in these folders please + make copies of them first. + +- drivers +- helpers +- init +- language +- libraries +- plugins +- scaffolding + +Please also replace your local copy of the user guide with the new +version. diff --git a/user_guide_src/source/installation/upgrade_130.rst b/user_guide_src/source/installation/upgrade_130.rst new file mode 100644 index 000000000..6d6d4b9ac --- /dev/null +++ b/user_guide_src/source/installation/upgrade_130.rst @@ -0,0 +1,125 @@ +######################### +Upgrading from 1.2 to 1.3 +######################### + +.. note:: The instructions on this page assume you are running version + 1.2. If you have not upgraded to that version please do so first. + +Before performing an update you should take your site offline by +replacing the index.php file with a static one. + +Step 1: Update your CodeIgniter files +===================================== + +Replace the following directories in your "system" folder with the new +versions: + +.. note:: If you have any custom developed files in these folders please + make copies of them first. + +- application/**models**/ (new for 1.3) +- codeigniter (new for 1.3) +- drivers +- helpers +- init +- language +- libraries +- plugins +- scaffolding + +Step 2: Update your error files +=============================== + +Version 1.3 contains two new error templates located in +application/errors, and for naming consistency the other error templates +have been renamed. + +If you **have not** customized any of the error templates simply replace +this folder: + +- application/errors/ + +If you **have** customized your error templates, rename them as follows: + +- 404.php = error_404.php +- error.php = error_general.php +- error_db.php (new) +- error_php.php (new) + +Step 3: Update your index.php file +================================== + +Please open your main index.php file (located at your root). At the very +bottom of the file, change this:: + + require_once BASEPATH.'libraries/Front_controller'.EXT; + +To this:: + + require_once BASEPATH.'codeigniter/CodeIgniter'.EXT; + +Step 4: Update your config.php file +=================================== + +Open your application/config/config.php file and add these new items:: + + + /* + |------------------------------------------------ + | URL suffix + |------------------------------------------------ + | + | This option allows you to add a suffix to all URLs. + | For example, if a URL is this: + | + | example.com/index.php/products/view/shoes + | + | You can optionally add a suffix, like ".html", + | making the page appear to be of a certain type: + | + | example.com/index.php/products/view/shoes.html + | + */ + $config['url_suffix'] = ""; + + + /* + |------------------------------------------------ + | Enable Query Strings + |------------------------------------------------ + | + | By default CodeIgniter uses search-engine and + | human-friendly segment based URLs: + | + | example.com/who/what/where/ + | + | You can optionally enable standard query string + | based URLs: + | + | example.com?who=me&what=something&where=here + | + | Options are: TRUE or FALSE (boolean) + | + | The two other items let you set the query string "words" + | that will invoke your controllers and functions: + | example.com/index.php?c=controller&m=function + | + */ + $config['enable_query_strings'] = FALSE; + $config['controller_trigger'] = 'c'; + $config['function_trigger'] = 'm'; + +Step 5: Update your database.php file +===================================== + +Open your application/config/database.php file and add these new items:: + + + $db['default']['dbprefix'] = ""; + $db['default']['active_r'] = TRUE; + +Step 6: Update your user guide +============================== + +Please also replace your local copy of the user guide with the new +version. diff --git a/user_guide_src/source/installation/upgrade_131.rst b/user_guide_src/source/installation/upgrade_131.rst new file mode 100644 index 000000000..8927c1b12 --- /dev/null +++ b/user_guide_src/source/installation/upgrade_131.rst @@ -0,0 +1,30 @@ +########################### +Upgrading from 1.3 to 1.3.1 +########################### + +.. note:: The instructions on this page assume you are running version + 1.3. If you have not upgraded to that version please do so first. + +Before performing an update you should take your site offline by +replacing the index.php file with a static one. + +Step 1: Update your CodeIgniter files +===================================== + +Replace the following directories in your "system" folder with the new +versions: + +.. note:: If you have any custom developed files in these folders please + make copies of them first. + +- drivers +- init/init_unit_test.php (new for 1.3.1) +- language/ +- libraries +- scaffolding + +Step 2: Update your user guide +============================== + +Please also replace your local copy of the user guide with the new +version. diff --git a/user_guide_src/source/installation/upgrade_132.rst b/user_guide_src/source/installation/upgrade_132.rst new file mode 100644 index 000000000..84b7cb4f7 --- /dev/null +++ b/user_guide_src/source/installation/upgrade_132.rst @@ -0,0 +1,28 @@ +############################# +Upgrading from 1.3.1 to 1.3.2 +############################# + +.. note:: The instructions on this page assume you are running version + 1.3.1. If you have not upgraded to that version please do so first. + +Before performing an update you should take your site offline by +replacing the index.php file with a static one. + +Step 1: Update your CodeIgniter files +===================================== + +Replace the following directories in your "system" folder with the new +versions: + +.. note:: If you have any custom developed files in these folders please + make copies of them first. + +- drivers +- init +- libraries + +Step 2: Update your user guide +============================== + +Please also replace your local copy of the user guide with the new +version. diff --git a/user_guide_src/source/installation/upgrade_133.rst b/user_guide_src/source/installation/upgrade_133.rst new file mode 100644 index 000000000..4212e4588 --- /dev/null +++ b/user_guide_src/source/installation/upgrade_133.rst @@ -0,0 +1,44 @@ +############################# +Upgrading from 1.3.2 to 1.3.3 +############################# + +.. note:: The instructions on this page assume you are running version + 1.3.2. If you have not upgraded to that version please do so first. + +Before performing an update you should take your site offline by +replacing the index.php file with a static one. + +Step 1: Update your CodeIgniter files +===================================== + +Replace the following directories in your "system" folder with the new +versions: + +.. note:: If you have any custom developed files in these folders please + make copies of them first. + +- codeigniter +- drivers +- helpers +- init +- libraries + +Step 2: Update your Models +========================== + +If you are **NOT** using CodeIgniter's +:doc:`Models <../general/models>` feature disregard this step. + +As of version 1.3.3, CodeIgniter does **not** connect automatically to +your database when a model is loaded. This allows you greater +flexibility in determining which databases you would like used with your +models. If your application is not connecting to your database prior to +a model being loaded you will have to update your code. There are +several options for connecting, :doc:`as described +here <../general/models>`. + +Step 3: Update your user guide +============================== + +Please also replace your local copy of the user guide with the new +version. diff --git a/user_guide_src/source/installation/upgrade_140.rst b/user_guide_src/source/installation/upgrade_140.rst new file mode 100644 index 000000000..987281fe1 --- /dev/null +++ b/user_guide_src/source/installation/upgrade_140.rst @@ -0,0 +1,72 @@ +############################# +Upgrading from 1.3.3 to 1.4.0 +############################# + +.. note:: The instructions on this page assume you are running version + 1.3.3. If you have not upgraded to that version please do so first. + +Before performing an update you should take your site offline by +replacing the index.php file with a static one. + +Step 1: Update your CodeIgniter files +===================================== + +Replace the following directories in your "system" folder with the new +versions: + +.. note:: If you have any custom developed files in these folders please + make copies of them first. + +- application/config/**hooks.php** +- application/config/**mimes.php** +- codeigniter +- drivers +- helpers +- init +- language +- libraries +- scaffolding + +Step 2: Update your config.php file +=================================== + +Open your application/config/config.php file and add these new items:: + + + + /* + |-------------------------------------------------------------------------- + | Enable/Disable System Hooks + |-------------------------------------------------------------------------- + | + | If you would like to use the "hooks" feature you must enable it by + | setting this variable to TRUE (boolean). See the user guide for details. + | + */ + $config['enable_hooks'] = FALSE; + + + /* + |-------------------------------------------------------------------------- + | Allowed URL Characters + |-------------------------------------------------------------------------- + | + | This lets you specify which characters are permitted within your URLs. + | When someone tries to submit a URL with disallowed characters they will + | get a warning message. + | + | As a security measure you are STRONGLY encouraged to restrict URLs to + | as few characters as possible. By default only these are allowed: a-z 0-9~%.:_- + | + | Leave blank to allow all characters -- but only if you are insane. + | + | DO NOT CHANGE THIS UNLESS YOU FULLY UNDERSTAND THE REPERCUSSIONS!! + | + */ + $config['permitted_uri_chars'] = 'a-z 0-9~%.:_-'; + +Step 3: Update your user guide +============================== + +Please also replace your local copy of the user guide with the new +version. diff --git a/user_guide_src/source/installation/upgrade_141.rst b/user_guide_src/source/installation/upgrade_141.rst new file mode 100644 index 000000000..c9c2ca461 --- /dev/null +++ b/user_guide_src/source/installation/upgrade_141.rst @@ -0,0 +1,71 @@ +############################# +Upgrading from 1.4.0 to 1.4.1 +############################# + +.. note:: The instructions on this page assume you are running version + 1.4.0. If you have not upgraded to that version please do so first. + +Before performing an update you should take your site offline by +replacing the index.php file with a static one. + +Step 1: Update your CodeIgniter files +===================================== + +Replace the following directories in your "system" folder with the new +versions: + +.. note:: If you have any custom developed files in these folders please + make copies of them first. + +- codeigniter +- drivers +- helpers +- libraries + +Step 2: Update your config.php file +=================================== + +Open your application/config/config.php file and add this new item:: + + + + /* + |-------------------------------------------------------------------------- + | Output Compression + |-------------------------------------------------------------------------- + | + | Enables Gzip output compression for faster page loads. When enabled, + | the output class will test whether your server supports Gzip. + | Even if it does, however, not all browsers support compression + | so enable only if you are reasonably sure your visitors can handle it. + | + | VERY IMPORTANT: If you are getting a blank page when compression is enabled it + | means you are prematurely outputting something to your browser. It could + | even be a line of whitespace at the end of one of your scripts. For + | compression to work, nothing can be sent before the output buffer is called + | by the output class. Do not "echo" any values with compression enabled. + | + */ + $config['compress_output'] = FALSE; + +Step 3: Rename an Autoload Item +=============================== + +Open the following file: application/config/autoload.php + +Find this array item:: + + $autoload['core'] = array(); + +And rename it to this:: + + $autoload['libraries'] = array(); + +This change was made to improve clarity since some users were not sure +that their own libraries could be auto-loaded. + +Step 4: Update your user guide +============================== + +Please also replace your local copy of the user guide with the new +version. diff --git a/user_guide_src/source/installation/upgrade_150.rst b/user_guide_src/source/installation/upgrade_150.rst new file mode 100644 index 000000000..bfe01ebba --- /dev/null +++ b/user_guide_src/source/installation/upgrade_150.rst @@ -0,0 +1,100 @@ +############################# +Upgrading from 1.4.1 to 1.5.0 +############################# + +.. note:: The instructions on this page assume you are running version + 1.4.1. If you have not upgraded to that version please do so first. + +Before performing an update you should take your site offline by +replacing the index.php file with a static one. + +Step 1: Update your CodeIgniter files +===================================== + +Replace these files and directories in your "system" folder with the new +versions: + +- application/config/user_agents.php (new file for 1.5) +- application/config/smileys.php (new file for 1.5) +- codeigniter/ +- database/ (new folder for 1.5. Replaces the "drivers" folder) +- helpers/ +- language/ +- libraries/ +- scaffolding/ + +.. note:: If you have any custom developed files in these folders please + make copies of them first. + +Step 2: Update your database.php file +===================================== + +Open your application/config/database.php file and add these new items:: + + + $db['default']['cache_on'] = FALSE; + $db['default']['cachedir'] = ''; + +Step 3: Update your config.php file +=================================== + +Open your application/config/config.php file and ADD these new items:: + + + /* + |-------------------------------------------------------------------------- + | Class Extension Prefix + |-------------------------------------------------------------------------- + | + | This item allows you to set the filename/classname prefix when extending + | native libraries. For more information please see the user guide: + | + | http://codeigniter.com/user_guide/general/core_classes.html + | http://codeigniter.com/user_guide/general/creating_libraries.html + | + */ + $config['subclass_prefix'] = 'MY_'; + + /* + |-------------------------------------------------------------------------- + | Rewrite PHP Short Tags + |-------------------------------------------------------------------------- + | + | If your PHP installation does not have short tag support enabled CI + | can rewrite the tags on-the-fly, enabling you to utilize that syntax + | in your view files. Options are TRUE or FALSE (boolean) + | + */ + $config['rewrite_short_tags'] = FALSE; + +In that same file REMOVE this item:: + + + /* + |-------------------------------------------------------------------------- + | Enable/Disable Error Logging + |-------------------------------------------------------------------------- + | + | If you would like errors or debug messages logged set this variable to + | TRUE (boolean). Note: You must set the file permissions on the "logs" folder + | such that it is writable. + | + */ + $config['log_errors'] = FALSE; + +Error logging is now disabled simply by setting the threshold to zero. + +Step 4: Update your main index.php file +======================================= + +If you are running a stock index.php file simply replace your version +with the new one. + +If your index.php file has internal modifications, please add your +modifications to the new file and use it. + +Step 5: Update your user guide +============================== + +Please also replace your local copy of the user guide with the new +version. diff --git a/user_guide_src/source/installation/upgrade_152.rst b/user_guide_src/source/installation/upgrade_152.rst new file mode 100644 index 000000000..781c907e1 --- /dev/null +++ b/user_guide_src/source/installation/upgrade_152.rst @@ -0,0 +1,39 @@ +############################# +Upgrading from 1.5.0 to 1.5.2 +############################# + +.. note:: The instructions on this page assume you are running version + 1.5.0 or 1.5.1. If you have not upgraded to that version please do so + first. + +Before performing an update you should take your site offline by +replacing the index.php file with a static one. + +Step 1: Update your CodeIgniter files +===================================== + +Replace these files and directories in your "system" folder with the new +versions: + +- system/helpers/download_helper.php +- system/helpers/form_helper.php +- system/libraries/Table.php +- system/libraries/User_agent.php +- system/libraries/Exceptions.php +- system/libraries/Input.php +- system/libraries/Router.php +- system/libraries/Loader.php +- system/libraries/Image_lib.php +- system/language/english/unit_test_lang.php +- system/database/DB_active_rec.php +- system/database/drivers/mysqli/mysqli_driver.php +- codeigniter/ + +.. note:: If you have any custom developed files in these folders please + make copies of them first. + +Step 2: Update your user guide +============================== + +Please also replace your local copy of the user guide with the new +version. diff --git a/user_guide_src/source/installation/upgrade_153.rst b/user_guide_src/source/installation/upgrade_153.rst new file mode 100644 index 000000000..e3d487be1 --- /dev/null +++ b/user_guide_src/source/installation/upgrade_153.rst @@ -0,0 +1,28 @@ +############################# +Upgrading from 1.5.2 to 1.5.3 +############################# + +Before performing an update you should take your site offline by +replacing the index.php file with a static one. + +Step 1: Update your CodeIgniter files +===================================== + +Replace these files and directories in your "system" folder with the new +versions: + +- system/database/drivers +- system/helpers +- system/libraries/Input.php +- system/libraries/Loader.php +- system/libraries/Profiler.php +- system/libraries/Table.php + +.. note:: If you have any custom developed files in these folders please + make copies of them first. + +Step 2: Update your user guide +============================== + +Please also replace your local copy of the user guide with the new +version. diff --git a/user_guide_src/source/installation/upgrade_154.rst b/user_guide_src/source/installation/upgrade_154.rst new file mode 100644 index 000000000..1d2c51d4a --- /dev/null +++ b/user_guide_src/source/installation/upgrade_154.rst @@ -0,0 +1,56 @@ +############################# +Upgrading from 1.5.3 to 1.5.4 +############################# + +Before performing an update you should take your site offline by +replacing the index.php file with a static one. + +Step 1: Update your CodeIgniter files +===================================== + +Replace these files and directories in your "system" folder with the new +versions: + +- application/config/mimes.php +- system/codeigniter +- system/database +- system/helpers +- system/libraries +- system/plugins + +.. note:: If you have any custom developed files in these folders please + make copies of them first. + +Step 2: Add charset to your config.php +====================================== + +Add the following to application/config/config.php + +:: + + /* + |-------------------------------------------------------------------------- + | Default Character Set + |-------------------------------------------------------------------------- + | + | This determines which character set is used by default in various methods + | that require a character set to be provided. + | + */ + $config['charset'] = "UTF-8"; + +Step 3: Autoloading language files +================================== + +If you want to autoload any language files, add this line to +application/config/autoload.php + +:: + + $autoload['language'] = array(); + +Step 4: Update your user guide +============================== + +Please also replace your local copy of the user guide with the new +version. diff --git a/user_guide_src/source/installation/upgrade_160.rst b/user_guide_src/source/installation/upgrade_160.rst new file mode 100644 index 000000000..e5d26611b --- /dev/null +++ b/user_guide_src/source/installation/upgrade_160.rst @@ -0,0 +1,87 @@ +############################# +Upgrading from 1.5.4 to 1.6.0 +############################# + +Before performing an update you should take your site offline by +replacing the index.php file with a static one. + +Step 1: Update your CodeIgniter files +===================================== + +Replace these files and directories in your "system" folder with the new +versions: + +- system/codeigniter +- system/database +- system/helpers +- system/libraries +- system/plugins +- system/language + +.. note:: If you have any custom developed files in these folders please + make copies of them first. + +Step 2: Add time_to_update to your config.php +=============================================== + +Add the following to application/config/config.php with the other +session configuration options + +:: + + $config['sess_time_to_update'] = 300; + + +Step 3: Add $autoload['model'] +============================== + +Add the following to application/config/autoload.php + +:: + + /* + | ------------------------------------------------------------------- + | Auto-load Model files + | ------------------------------------------------------------------- + | Prototype: + | + | $autoload['model'] = array('my_model'); + | + */ + + $autoload['model'] = array(); + + +Step 4: Add to your database.php +================================ + +Make the following changes to your application/config/database.php file: + +Add the following variable above the database configuration options, +with $active_group + +:: + + $active_record = TRUE; + + +Remove the following from your database configuration options + +:: + + $db['default']['active_r'] = TRUE; + + +Add the following to your database configuration options + +:: + + $db['default']['char_set'] = "utf8"; + $db['default']['dbcollat'] = "utf8_general_ci"; + + +Step 5: Update your user guide +============================== + +Please also replace your local copy of the user guide with the new +version. diff --git a/user_guide_src/source/installation/upgrade_161.rst b/user_guide_src/source/installation/upgrade_161.rst new file mode 100644 index 000000000..43869223f --- /dev/null +++ b/user_guide_src/source/installation/upgrade_161.rst @@ -0,0 +1,27 @@ +############################# +Upgrading from 1.6.0 to 1.6.1 +############################# + +Before performing an update you should take your site offline by +replacing the index.php file with a static one. + +Step 1: Update your CodeIgniter files +===================================== + +Replace these files and directories in your "system" folder with the new +versions: + +- system/codeigniter +- system/database +- system/helpers +- system/language +- system/libraries + +.. note:: If you have any custom developed files in these folders please + make copies of them first. + +Step 2: Update your user guide +============================== + +Please also replace your local copy of the user guide with the new +version. diff --git a/user_guide_src/source/installation/upgrade_162.rst b/user_guide_src/source/installation/upgrade_162.rst new file mode 100644 index 000000000..6a618e4ad --- /dev/null +++ b/user_guide_src/source/installation/upgrade_162.rst @@ -0,0 +1,45 @@ +############################# +Upgrading from 1.6.1 to 1.6.2 +############################# + +Before performing an update you should take your site offline by +replacing the index.php file with a static one. + +Step 1: Update your CodeIgniter files +===================================== + +Replace these files and directories in your "system" folder with the new +versions: + +- system/codeigniter +- system/database +- system/helpers +- system/language +- system/libraries + +.. note:: If you have any custom developed files in these folders please + make copies of them first. + +Step 2: Encryption Key +====================== + +If you are using sessions, open up application/config/config.php and +verify you've set an encryption key. + +Step 3: Constants File +====================== + +Copy /application/config/constants.php to your installation, and modify +if necessary. + +Step 4: Mimes File +================== + +Replace /application/config/mimes.php with the dowloaded version. If +you've added custom mime types, you'll need to re-add them. + +Step 5: Update your user guide +============================== + +Please also replace your local copy of the user guide with the new +version. diff --git a/user_guide_src/source/installation/upgrade_163.rst b/user_guide_src/source/installation/upgrade_163.rst new file mode 100644 index 000000000..e24e20357 --- /dev/null +++ b/user_guide_src/source/installation/upgrade_163.rst @@ -0,0 +1,27 @@ +############################# +Upgrading from 1.6.2 to 1.6.3 +############################# + +Before performing an update you should take your site offline by +replacing the index.php file with a static one. + +Step 1: Update your CodeIgniter files +===================================== + +Replace these files and directories in your "system" folder with the new +versions: + +- system/codeigniter +- system/database +- system/helpers +- system/language +- system/libraries + +.. note:: If you have any custom developed files in these folders please + make copies of them first. + +Step 2: Update your user guide +============================== + +Please also replace your local copy of the user guide with the new +version. diff --git a/user_guide_src/source/installation/upgrade_170.rst b/user_guide_src/source/installation/upgrade_170.rst new file mode 100644 index 000000000..fefb2ea51 --- /dev/null +++ b/user_guide_src/source/installation/upgrade_170.rst @@ -0,0 +1,56 @@ +############################# +Upgrading from 1.6.3 to 1.7.0 +############################# + +Before performing an update you should take your site offline by +replacing the index.php file with a static one. + +Step 1: Update your CodeIgniter files +===================================== + +Replace these files and directories in your "system" folder with the new +versions: + +- system/codeigniter +- system/database +- system/helpers +- system/language +- system/libraries + +.. note:: If you have any custom developed files in these folders please + make copies of them first. + +Step 2: Update your Session Table +================================= + +If you are using the Session class in your application, AND if you are +storing session data to a database, you must add a new column named +user_data to your session table. Here is an example of what this column +might look like for MySQL:: + + user_data text NOT NULL + +To add this column you will run a query similar to this:: + + ALTER TABLE `ci_sessions` ADD `user_data` text NOT NULL + +You'll find more information regarding the new Session functionality in +the :doc:`Session class <../libraries/sessions>` page. + +Step 3: Update your Validation Syntax +===================================== + +This is an **optional**, but recommended step, for people currently +using the Validation class. CI 1.7 introduces a new :doc:`Form Validation +class <../libraries/form_validation>`, which deprecates the old +Validation library. We have left the old one in place so that existing +applications that use it will not break, but you are encouraged to +migrate to the new version as soon as possible. Please read the user +guide carefully as the new library works a little differently, and has +several new features. + +Step 4: Update your user guide +============================== + +Please replace your local copy of the user guide with the new version, +including the image files. diff --git a/user_guide_src/source/installation/upgrade_171.rst b/user_guide_src/source/installation/upgrade_171.rst new file mode 100644 index 000000000..e791b4eba --- /dev/null +++ b/user_guide_src/source/installation/upgrade_171.rst @@ -0,0 +1,27 @@ +############################# +Upgrading from 1.7.0 to 1.7.1 +############################# + +Before performing an update you should take your site offline by +replacing the index.php file with a static one. + +Step 1: Update your CodeIgniter files +===================================== + +Replace these files and directories in your "system" folder with the new +versions: + +- system/codeigniter +- system/database +- system/helpers +- system/language +- system/libraries + +.. note:: If you have any custom developed files in these folders please + make copies of them first. + +Step 2: Update your user guide +============================== + +Please replace your local copy of the user guide with the new version, +including the image files. diff --git a/user_guide_src/source/installation/upgrade_172.rst b/user_guide_src/source/installation/upgrade_172.rst new file mode 100644 index 000000000..16f6dec1f --- /dev/null +++ b/user_guide_src/source/installation/upgrade_172.rst @@ -0,0 +1,48 @@ +############################# +Upgrading from 1.7.1 to 1.7.2 +############################# + +Before performing an update you should take your site offline by +replacing the index.php file with a static one. + +Step 1: Update your CodeIgniter files +===================================== + +Replace these files and directories in your "system" folder with the new +versions: + +- system/codeigniter +- system/database +- system/helpers +- system/language +- system/libraries +- index.php + +.. note:: If you have any custom developed files in these folders please + make copies of them first. + +Step 2: Remove header() from 404 error template +=============================================== + +If you are using header() in your 404 error template, such as the case +with the default error_404.php template shown below, remove that line +of code. + +:: + + <?php header("HTTP/1.1 404 Not Found"); ?> + +404 status headers are now properly handled in the show_404() method +itself. + +Step 3: Confirm your system_path +================================= + +In your updated index.php file, confirm that the $system_path variable +is set to your application's system folder. + +Step 4: Update your user guide +============================== + +Please replace your local copy of the user guide with the new version, +including the image files. diff --git a/user_guide_src/source/installation/upgrade_200.rst b/user_guide_src/source/installation/upgrade_200.rst new file mode 100644 index 000000000..29f44bd9e --- /dev/null +++ b/user_guide_src/source/installation/upgrade_200.rst @@ -0,0 +1,149 @@ +############################# +Upgrading from 1.7.2 to 2.0.0 +############################# + +Before performing an update you should take your site offline by +replacing the index.php file with a static one. + +******************* +Update Instructions +******************* + +Step 1: Update your CodeIgniter files +===================================== + +Replace all files and directories in your "system" folder **except** +your application folder. + +.. note:: If you have any custom developed files in these folders please + make copies of them first. + +Step 2: Adjust get_dir_file_info() where necessary +===================================================== + +Version 2.0.0 brings a non-backwards compatible change to +get_dir_file_info() in the :doc:`File +Helper <../helpers/file_helper>`. Non-backwards compatible changes +are extremely rare in CodeIgniter, but this one we feel was warranted +due to how easy it was to create serious server performance issues. If +you *need* recursiveness where you are using this helper function, +change such instances, setting the second parameter, $top_level_only +to FALSE:: + + get_dir_file_info('/path/to/directory', FALSE); + +Step 3: Convert your Plugins to Helpers +======================================= + +2.0.0 gets rid of the "Plugin" system as their functionality was +identical to Helpers, but non-extensible. You will need to rename your +plugin files from filename_pi.php to filename_helper.php, move them to +your helpers folder, and change all instances of:: + + $this->load->plugin('foo'); + +to :: + + $this->load->helper('foo'); + + +Step 4: Update stored encrypted data +==================================== + +.. note:: If your application does not use the Encryption library, does + not store Encrypted data permanently, or is on an environment that does + not support Mcrypt, you may skip this step. + +The Encryption library has had a number of improvements, some for +encryption strength and some for performance, that has an unavoidable +consequence of making it no longer possible to decode encrypted data +produced by the original version of this library. To help with the +transition, a new method has been added, encode_from_legacy() that +will decode the data with the original algorithm and return a re-encoded +string using the improved methods. This will enable you to easily +replace stale encrypted data with fresh in your applications, either on +the fly or en masse. + +Please read `how to use this +method <../libraries/encryption.html#legacy>`_ in the Encryption library +documentation. + +Step 5: Remove loading calls for the compatibility helper. +========================================================== + +The compatibility helper has been removed from the CodeIgniter core. All +methods in it should be natively available in supported PHP versions. + +Step 6: Update Class extension +============================== + +All core classes are now prefixed with CI\_. Update Models and +Controllers to extend CI_Model and CI_Controller, respectively. + +Step 7: Update Parent Constructor calls +======================================= + +All native CodeIgniter classes now use the PHP 5 \__construct() +convention. Please update extended libraries to call +parent::\__construct(). + +Step 8: Move any core extensions to application/core +==================================================== + +Any extensions to core classes (e.g. MY_Controller.php) in your +application/libraries folder must be moved to the new +application/core folder. + +Step 9: Update your user guide +============================== + +Please replace your local copy of the user guide with the new version, +including the image files. + + +************ +Update Notes +************ + +Please refer to the :ref:`2.0.0 Change Log <2.0.0-changelog>` for full +details, but here are some of the larger changes that are more likely to +impact your code: + +- CodeIgniter now requires PHP 5.2.4. +- Scaffolding has been removed. +- The CAPTCHA plugin in now a :doc:`helper </helpers/captcha_helper>`. +- The JavaScript calendar plugin was removed. +- The *system/cache* and *system/logs* directories are now in the application + directory. +- The Validation class has been removed. Please see the + :doc:`Form Validation library </libraries/form_validation>` +- "default" is now a reserved name. +- The xss_clean() function has moved to the :doc:`Security Class + </libraries/security>`. +- do_xss_clean() now returns FALSE if the uploaded file fails XSS checks. +- The :doc:`Session Class </libraries/sessions>` requires now the use of an + encryption key set in the config file. +- The following deprecated Active Record functions have been removed: + ``orwhere``, ``orlike``, ``groupby``, ``orhaving``, ``orderby``, + ``getwhere``. +- ``_drop_database()`` and ``_create_database()`` functions have been removed + from the db utility drivers. +- The ``dohash()`` function of the :doc:`Security helper + </helpers/security_helper>` + has been renamed to ``do_hash()`` for naming consistency. + +The config folder +================= + +The following files have been changed: + +- config.php +- database.php +- mimes.php +- routes.php +- user_agents.php + +The following files have been added: + +- foreign_chars.php +- profiler.php diff --git a/user_guide_src/source/installation/upgrade_201.rst b/user_guide_src/source/installation/upgrade_201.rst new file mode 100644 index 000000000..93e1aa68d --- /dev/null +++ b/user_guide_src/source/installation/upgrade_201.rst @@ -0,0 +1,39 @@ +############################# +Upgrading from 2.0.0 to 2.0.1 +############################# + +Before performing an update you should take your site offline by +replacing the index.php file with a static one. + +Step 1: Update your CodeIgniter files +===================================== + +Replace all files and directories in your "system" folder and replace +your index.php file. If any modifications were made to your index.php +they will need to be made fresh in this new one. + +.. note:: If you have any custom developed files in these folders please + make copies of them first. + +Step 2: Replace config/mimes.php +================================ + +This config file has been updated to contain more mime types, please +copy it to application/config/mimes.php. + +Step 3: Check for forms posting to default controller +===================================================== + +The default behavior for form_open() when called with no parameters +used to be to post to the default controller, but it will now just leave +an empty action="" meaning the form will submit to the current URL. If +submitting to the default controller was the expected behavior it will +need to be changed from:: + + echo form_open(); //<form action="" method="post" accept-charset="utf-8"> + +to use either a / or base_url():: + + echo form_open('/'); //<form action="http://example.com/index.php/" method="post" accept-charset="utf-8"> + echo form_open(base_url()); //<form action="http://example.com/" method="post" accept-charset="utf-8"> + diff --git a/user_guide_src/source/installation/upgrade_202.rst b/user_guide_src/source/installation/upgrade_202.rst new file mode 100644 index 000000000..8dbd38aff --- /dev/null +++ b/user_guide_src/source/installation/upgrade_202.rst @@ -0,0 +1,33 @@ +############################# +Upgrading from 2.0.1 to 2.0.2 +############################# + +Before performing an update you should take your site offline by +replacing the index.php file with a static one. + +Step 1: Update your CodeIgniter files +===================================== + +Replace all files and directories in your "system" folder and replace +your index.php file. If any modifications were made to your index.php +they will need to be made fresh in this new one. + +.. note:: If you have any custom developed files in these folders please + make copies of them first. + +Step 2: Remove loading calls for the Security Library +===================================================== + +Security has been moved to the core and is now always loaded +automatically. Make sure you remove any loading calls as they will +result in PHP errors. + +Step 3: Move MY_Security +========================= + +If you are overriding or extending the Security library, you will need +to move it to application/core. + +csrf_token_name and csrf_hash have changed to protected class +properties. Please use security->get_csrf_hash() and +security->get_csrf_token_name() to access those values. diff --git a/user_guide_src/source/installation/upgrade_203.rst b/user_guide_src/source/installation/upgrade_203.rst new file mode 100644 index 000000000..717aa3e50 --- /dev/null +++ b/user_guide_src/source/installation/upgrade_203.rst @@ -0,0 +1,63 @@ +############################# +Upgrading from 2.0.2 to 2.0.3 +############################# + +Before performing an update you should take your site offline by +replacing the index.php file with a static one. + +Step 1: Update your CodeIgniter files +===================================== + +Replace all files and directories in your "system" folder and replace +your index.php file. If any modifications were made to your index.php +they will need to be made fresh in this new one. + +.. note:: If you have any custom developed files in these folders please + make copies of them first. + +Step 2: Update your main index.php file +======================================= + +If you are running a stock index.php file simply replace your version +with the new one. + +If your index.php file has internal modifications, please add your +modifications to the new file and use it. + +Step 3: Replace config/user_agents.php +======================================= + +This config file has been updated to contain more user agent types, +please copy it to application/config/user_agents.php. + +Step 4: Change references of the EXT constant to ".php" +======================================================= + +.. note:: The EXT Constant has been marked as deprecated, but has not + been removed from the application. You are encouraged to make the + changes sooner rather than later. + +Step 5: Remove APPPATH.'third_party' from autoload.php +======================================================= + +Open application/config/autoload.php, and look for the following:: + + $autoload['packages'] = array(APPPATH.'third_party'); + +If you have not chosen to load any additional packages, that line can be +changed to:: + + $autoload['packages'] = array(); + +Which should provide for nominal performance gains if not autoloading +packages. + +Update Sessions Database Tables +=============================== + +If you are using database sessions with the CI Session Library, please +update your ci_sessions database table as follows:: + + CREATE INDEX last_activity_idx ON ci_sessions(last_activity); + ALTER TABLE ci_sessions MODIFY user_agent VARCHAR(120); + diff --git a/user_guide_src/source/installation/upgrade_210.rst b/user_guide_src/source/installation/upgrade_210.rst new file mode 100644 index 000000000..5874bfc86 --- /dev/null +++ b/user_guide_src/source/installation/upgrade_210.rst @@ -0,0 +1,26 @@ +############################# +Upgrading from 2.0.3 to 2.1.0 +############################# + +Before performing an update you should take your site offline by +replacing the index.php file with a static one. + +Step 1: Update your CodeIgniter files +===================================== + +Replace all files and directories in your "system" folder. + +.. note:: If you have any custom developed files in these folders please + make copies of them first. + +Step 2: Replace config/user_agents.php +====================================== + +This config file has been updated to contain more user agent types, +please copy it to _application/config/user_agents.php*. + +Step 3: Update your user guide +============================== + +Please also replace your local copy of the user guide with the new +version.
\ No newline at end of file diff --git a/user_guide_src/source/installation/upgrade_211.rst b/user_guide_src/source/installation/upgrade_211.rst new file mode 100644 index 000000000..59faca8e6 --- /dev/null +++ b/user_guide_src/source/installation/upgrade_211.rst @@ -0,0 +1,33 @@ +############################# +Upgrading from 2.1.0 to 2.1.1 +############################# + +Before performing an update you should take your site offline by +replacing the index.php file with a static one. + +Step 1: Update your CodeIgniter files +===================================== + +Replace all files and directories in your "system" folder and replace +your index.php file. If any modifications were made to your index.php +they will need to be made fresh in this new one. + +.. note:: If you have any custom developed files in these folders please + make copies of them first. + +Step 2: Replace config/mimes.php +================================ + +This config file has been updated to contain more user mime-types, please copy +it to _application/config/mimes.php*. + +Step 3: Update your IP address tables +===================================== + +This upgrade adds support for IPv6 IP addresses. In order to store them, you need +to enlarge your ip_address columns to 45 characters. For example, CodeIgniter's +session table will need to change + +:: + + ALTER TABLE ci_sessions CHANGE ip_address ip_address varchar(45) default '0' NOT NULL
\ No newline at end of file diff --git a/user_guide_src/source/installation/upgrade_212.rst b/user_guide_src/source/installation/upgrade_212.rst new file mode 100644 index 000000000..205ad8622 --- /dev/null +++ b/user_guide_src/source/installation/upgrade_212.rst @@ -0,0 +1,22 @@ +############################# +Upgrading from 2.1.1 to 2.1.2 +############################# + +Before performing an update you should take your site offline by +replacing the index.php file with a static one. + +Step 1: Update your CodeIgniter files +===================================== + +Replace all files and directories in your "system" folder and replace +your index.php file. If any modifications were made to your index.php +they will need to be made fresh in this new one. + +.. note:: If you have any custom developed files in these folders please + make copies of them first. + +Step 2: Update your user guide +============================== + +Please also replace your local copy of the user guide with the new +version.
\ No newline at end of file diff --git a/user_guide_src/source/installation/upgrade_300.rst b/user_guide_src/source/installation/upgrade_300.rst new file mode 100644 index 000000000..f304a716f --- /dev/null +++ b/user_guide_src/source/installation/upgrade_300.rst @@ -0,0 +1,141 @@ +############################# +Upgrading from 2.1.2 to 3.0.0 +############################# + +.. note:: These upgrade notes are for a version that is yet to be released. + +Before performing an update you should take your site offline by replacing the index.php file with a static one. + +************************************* +Step 1: Update your CodeIgniter files +************************************* + +Replace all files and directories in your "system" folder and replace +your index.php file. If any modifications were made to your index.php +they will need to be made fresh in this new one. + +.. note:: If you have any custom developed files in these folders please + make copies of them first. + +******************************** +Step 2: Replace config/mimes.php +******************************** + +This config file has been updated to contain more user mime-types, please copy +it to _application/config/mimes.php*. + +************************************************************** +Step 3: Remove $autoload['core'] from your config/autoload.php +************************************************************** + +Use of the ``$autoload['core']`` config array has been deprecated as of CodeIgniter 1.4.1 and is now removed. +Move any entries that you might have listed there to ``$autoload['libraries']`` instead. + +*************************************** +Step 4: Update your config/database.php +*************************************** + +Due to 3.0.0's renaming of Active Record to Query Builder, inside your `config/database.php`, you will +need to rename the `$active_record` variable to `$query_builder`. + + $active_group = 'default'; + // $active_record = TRUE; + $query_builder = TRUE; + +******************************* +Step 5: Move your errors folder +******************************* + +In version 3.0.0, the errors folder has been moved from _application/errors* to _application/views/errors*. + +**************************************************************************** +Step 6: Check the calls to Array Helper's element() and elements() functions +**************************************************************************** + +The default return value of these functions, when the required elements +don't exist, has been changed from FALSE to NULL. + +*************************************************************** +Step 7: Remove usage of (previously) deprecated functionalities +*************************************************************** + +In addition to the ``$autoload['core']`` configuration setting, there's a number of other functionalities +that have been removed in CodeIgniter 3.0.0: + +The SHA1 library +================ + +The previously deprecated SHA1 library has been removed, alter your code to use PHP's native +``sha1()`` function to generate a SHA1 hash. + +Additionally, the ``sha1()`` method in the :doc:`Encryption Library <../libraries/encryption>` has been removed. + +The EXT constant +================ + +Usage of the ``EXT`` constant has been deprecated since dropping support for PHP 4. There's no +longer a need to maintain different filename extensions and in this new CodeIgniter version, +the ``EXT`` constant has been removed. Use just '.php' instead. + +Smiley helper js_insert_smiley() +================================ + +:doc:`Smiley Helper <../helpers/smiley_helper>` function ``js_insert_smiley()`` has been deprecated +since CodeIgniter 1.7.2 and is now removed. You'll need to switch to ``smiley_js()`` instead. + +Security helper do_hash() +========================= + +:doc:`Security Helper <../helpers/security_helper>` function ``do_hash()`` is now just an alias for +PHP's native ``hash()`` function. It is deprecated and scheduled for removal in CodeIgniter 3.1+. + +.. note:: This function is still available, but you're strongly encouraged to remove it's usage sooner + rather than later. + +File helper read_file() +======================= + +:doc:`File Helper <../helpers/file_helper>` function ``read_file()`` is now just an alias for +PHP's native ``file_get_contents()`` function. It is deprecated and scheduled for removal in +CodeIgniter 3.1+. + +.. note:: This function is still available, but you're strongly encouraged to remove it's usage sooner + rather than later. + +Date helper standard_date() +=========================== + +:doc:`Date Helper <../helpers/date_helper>` function ``standard_date()`` is being deprecated due +to the availability of native PHP `constants <http://www.php.net/manual/en/class.datetime.php#datetime.constants.types>`_, +which when combined with ``date()`` provide the same functionality. Furthermore, they have the +exact same names as the ones supported by ``standard_date()``. Here are examples of how to replace +it's usage: + +:: + + // Old way + standard_date(); // defaults to standard_date('DATE_RFC822', now()); + + // Replacement + date(DATE_RFC822, now()); + + // Old way + standard_date('DATE_ATOM', $time); + + // Replacement + date(DATE_ATOM, $time); + +.. note:: This function is still available, but you're strongly encouraged to remove its' usage sooner + rather than later as it is scheduled for removal in CodeIgniter 3.1+. + +Pagination library 'anchor_class' setting +========================================= + +The :doc:`Pagination Library <../libraries/pagination>` now supports adding pretty much any HTML +attribute to your anchors via the 'attributes' configuration setting. This includes passing the +'class' attribute and using the separate 'anchor_class' setting no longer makes sense. +As a result of that, the 'anchor_class' setting is now deprecated and scheduled for removal in +CodeIgniter 3.1+. + +.. note:: This setting is still available, but you're strongly encouraged to remove its' usage sooner + rather than later.
\ No newline at end of file diff --git a/user_guide_src/source/installation/upgrade_b11.rst b/user_guide_src/source/installation/upgrade_b11.rst new file mode 100644 index 000000000..e70759be6 --- /dev/null +++ b/user_guide_src/source/installation/upgrade_b11.rst @@ -0,0 +1,78 @@ +################################### +Upgrading From Beta 1.0 to Beta 1.1 +################################### + +To upgrade to Beta 1.1 please perform the following steps: + +Step 1: Replace your index file +=============================== + +Replace your main index.php file with the new index.php file. Note: If +you have renamed your "system" folder you will need to edit this info in +the new file. + +Step 2: Relocate your config folder +=================================== + +This version of CodeIgniter now permits multiple sets of "applications" +to all share a common set of backend files. In order to enable each +application to have its own configuration values, the config directory +must now reside inside of your application folder, so please move it +there. + +Step 3: Replace directories +=========================== + +Replace the following directories with the new versions: + +- drivers +- helpers +- init +- libraries +- scaffolding + +Step 4: Add the calendar language file +====================================== + +There is a new language file corresponding to the new calendaring class +which must be added to your language folder. Add the following item to +your version: language/english/calendar_lang.php + +Step 5: Edit your config file +============================= + +The original application/config/config.php file has a typo in it Open +the file and look for the items related to cookies:: + + $conf['cookie_prefix'] = ""; + $conf['cookie_domain'] = ""; + $conf['cookie_path'] = "/"; + +Change the array name from $conf to $config, like this:: + + $config['cookie_prefix'] = ""; + $config['cookie_domain'] = ""; + $config['cookie_path'] = "/"; + +Lastly, add the following new item to the config file (and edit the +option if needed):: + + + /* + |------------------------------------------------ + | URI PROTOCOL + |------------------------------------------------ + | + | This item determines which server global + | should be used to retrieve the URI string. The + | default setting of "auto" works for most servers. + | If your links do not seem to work, try one of + | the other delicious flavors: + | + | 'auto' Default - auto detects + | 'path_info' Uses the PATH_INFO + | 'query_string' Uses the QUERY_STRING + */ + + $config['uri_protocol'] = "auto"; + diff --git a/user_guide_src/source/installation/upgrading.rst b/user_guide_src/source/installation/upgrading.rst new file mode 100644 index 000000000..545f344ee --- /dev/null +++ b/user_guide_src/source/installation/upgrading.rst @@ -0,0 +1,35 @@ +################################# +Upgrading From a Previous Version +################################# + +Please read the upgrade notes corresponding to the version you are +upgrading from. + +- :doc:`Upgrading from 2.1.2 to 3.0.0 <upgrade_300>` +- :doc:`Upgrading from 2.1.1 to 2.1.2 <upgrade_212>` +- :doc:`Upgrading from 2.1.0 to 2.1.1 <upgrade_211>` +- :doc:`Upgrading from 2.0.3 to 2.1.0 <upgrade_210>` +- :doc:`Upgrading from 2.0.2 to 2.0.3 <upgrade_203>` +- :doc:`Upgrading from 2.0.1 to 2.0.2 <upgrade_202>` +- :doc:`Upgrading from 2.0 to 2.0.1 <upgrade_201>` +- :doc:`Upgrading from 1.7.2 to 2.0 <upgrade_200>` +- :doc:`Upgrading from 1.7.1 to 1.7.2 <upgrade_172>` +- :doc:`Upgrading from 1.7.0 to 1.7.1 <upgrade_171>` +- :doc:`Upgrading from 1.6.3 to 1.7.0 <upgrade_170>` +- :doc:`Upgrading from 1.6.2 to 1.6.3 <upgrade_163>` +- :doc:`Upgrading from 1.6.1 to 1.6.2 <upgrade_162>` +- :doc:`Upgrading from 1.6.0 to 1.6.1 <upgrade_161>` +- :doc:`Upgrading from 1.5.4 to 1.6.0 <upgrade_160>` +- :doc:`Upgrading from 1.5.3 to 1.5.4 <upgrade_154>` +- :doc:`Upgrading from 1.5.2 to 1.5.3 <upgrade_153>` +- :doc:`Upgrading from 1.5.0 or 1.5.1 to 1.5.2 <upgrade_152>` +- :doc:`Upgrading from 1.4.1 to 1.5.0 <upgrade_150>` +- :doc:`Upgrading from 1.4.0 to 1.4.1 <upgrade_141>` +- :doc:`Upgrading from 1.3.3 to 1.4.0 <upgrade_140>` +- :doc:`Upgrading from 1.3.2 to 1.3.3 <upgrade_133>` +- :doc:`Upgrading from 1.3.1 to 1.3.2 <upgrade_132>` +- :doc:`Upgrading from 1.3 to 1.3.1 <upgrade_131>` +- :doc:`Upgrading from 1.2 to 1.3 <upgrade_130>` +- :doc:`Upgrading from 1.1 to 1.2 <upgrade_120>` +- :doc:`Upgrading from Beta 1.0 to Beta 1.1 <upgrade_b11>` + |