Source: /README.txt - 130 lines - 6311 bytes - Text - Print

   1  Textpattern CMS 4.8.4
   2  
   3  Released under the GNU General Public License.
   4  See LICENSE.txt for terms and conditions.
   5  
   6  Includes contributions licensed under the GNU Lesser General Public License.
   7  See textpattern/lib/LICENSE-LESSER.txt for terms and conditions.
   8  
   9  Includes contributions licensed under the New BSD License.
  10  See textpattern/lib/LICENSE-BSD-3.txt for terms and conditions.
  11  
  12  
  13  == About ==
  14  
  15  Textpattern CMS is a flexible, elegant and easy-to-use content management
  16  system. Textpattern is free and open source.
  17  
  18  
  19  == Getting Started ==
  20  
  21  * The Textpattern FAQ is available at https://textpattern.com/faq/
  22  * In-depth documentation and a comprehensive tag index is available in the
  23    Textpattern user documentation at https://docs.textpattern.com/
  24  * You can get support and information via:
  25     Forum:    https://forum.textpattern.com/
  26     GitHub:   https://textpattern.com/github
  27     Twitter:  https://textpattern.com/@textpattern
  28  
  29  
  30  == Installation ==
  31  
  32  * Extract the Textpattern files to your site (in the web root, subdomain or
  33    subdirectory). The top-level index.php file should reside in this directory,
  34    as should the /textpattern/, /files/, /images/, /rpc/ and /themes/
  35    directories.
  36  * If you are running Textpattern on an Apache web server, ensure the top-level
  37    .htaccess file is transferred to your site. The file is hidden by default on
  38    some operating systems, including macOS. FTP clients and IDEs typically have
  39    an option to show these hidden files. You can show or hide hidden files in
  40    macOS Finder with the Cmd + Shift + . keyboard shortcut.
  41  * Create or verify the existence of a working MySQL database with valid username
  42    and password. From Textpattern 4.6.0, the MySQL database user requires INDEX
  43    permissions in addition to pre-existing permissions. Refer to the system
  44    requirements for a complete list:
  45      https://textpattern.com/system-requirements
  46  * Load /textpattern/setup/ (or /subdirectory/textpattern/setup/) in your
  47    browser to start the installation process and follow the directions.
  48  * When the installation is complete, remove the /textpattern/setup/ directory
  49    from your site.
  50  * If you are running Textpattern on an Apache web server, you can rename
  51    /files/.htaccess-dist to /files/.htaccess to prohibit direct URL access to
  52    your uploaded files. Thus the only route to these files becomes through the
  53    /file_download/ directory. It is recommended you consider employing this
  54    feature. Alternatively, move your /files/ directory out of a web-accessible
  55    location. Once moved, you can specify your new directory location from the
  56    Textpattern Admin Preferences (Admin -> Preferences -> Admin).
  57  
  58  
  59  == IMPORTANT ==
  60  
  61  * Check back regularly at https://textpattern.com/ to see if an update is
  62    available. Updates are as painless as possible, often extending functionality,
  63    fixing bugs and/or security-related issues. Textpattern's diagnostics
  64    (Admin -> Diagnostics) will display a message if a new version is available.
  65  
  66  
  67  == Upgrading: preflight ==
  68  
  69  * Read the release notes in HISTORY.txt, both for the version you are upgrading
  70    to and any prior versions you are skipping as these changes will apply.
  71    Ensure you understand any changes and enhancements that may affect your
  72    Textpattern site functionality. If in doubt, refer to the resources in the
  73    Getting Started section above before you undertake the upgrade process.
  74  * Confirm your web server meets or exceeds the Textpattern system requirements:
  75      https://textpattern.com/system-requirements
  76  * It is recommended that the browser cache is cleared to ensure the newer files
  77    are used in preference to the older files.
  78  * NOTE: Versions prior to 4.2.0 should be upgraded to 4.2.0 before subsequent
  79    version upgrades. Upgrades from versions prior to 4.2.0 will present warnings
  80    and/or errors upon the first login to the admin-side. These may include:
  81      Unknown column 'user_name' in 'where clause' select name,
  82      val from txp_prefs where prefs_id=1 AND user_name='' in
  83      /path/to/your/site/textpattern/lib/txplib_db.php on line xx
  84      Undefined variable: language in
  85      /path/to/your/site/textpattern/index.php at line xx
  86      Undefined variable: gmtoffset in
  87      /path/to/your/site/textpattern/update/_to_4.2.0.php at line xx
  88    This is expected behaviour. The messages will disappear with subsequent
  89    navigation in the admin-side.
  90  * NOTE: Upgrades from versions prior to 4.7.0 may present an 'Unknown section'
  91    message on the front side after updated files have been transferred and
  92    before the first admin-side log in. The message will disappear following the
  93    first log in when the database upgrade scripts are run.
  94  
  95  == Upgrading ==
  96  
  97  * Log out of the Textpattern admin-side.
  98  * Verify the existence of a known-good Textpattern database and file backup.
  99  * Ensure your Textpattern database user has INDEX permissions in addition to
 100    any permissions previously granted.
 101  * Replace the top-level index.php, css.php and .htaccess files (if Textpattern
 102    is running on an Apache or derivative web server), everything in the /rpc/
 103    directory and everything in the /textpattern/ directory (except
 104    /textpattern/config.php and the /textpattern/setup/ directory) with the
 105    corresponding files in this distribution. In addition, ensure the /themes/
 106    directory exists if it is not already there, and is writable.
 107    When uploading the /textpattern/ directory, ensure you preserve any custom
 108    files in your existing installation. Also ensure the /textpattern/plugins
 109    directory is writable.
 110    Note: css.php and /rpc/ may not exist if the installed version of
 111    Textpattern is prior to 4.2.0.
 112  * Log in to the Textpattern admin-side. The upgrade script(s) will run
 113    automatically. Check the site diagnostics (Admin -> Diagnostics) to confirm
 114    the correct Textpattern version number is displayed and whether there are any
 115    errors.
 116  * Verify all preference settings (Admin -> Preferences).
 117  
 118  
 119  == Additional Resources ==
 120  
 121  * There are additional resources for the default front-side theme, such as
 122    Sass preprocessor files, available at:
 123      https://github.com/textpattern/textpattern-default-theme/
 124  
 125  
 126  == Contributing ==
 127  
 128  Want to help out with the development of Textpattern CMS? Please refer to the
 129  Contributing documentation https://docs.textpattern.com/development/contributing
 130  for full details.