Source: /README.txt - 115 lines - 5266 bytes - Text - Print

   1  Textpattern CMS 4.6.2
   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 LICENSE-LESSER.txt for terms and conditions.
   8  
   9  Includes contributions licensed under the New BSD License.
  10  See 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 both free and open source.
  17  
  18  
  19  == Getting Started ==
  20  
  21  * The Textpattern FAQ is available at http://textpattern.com/faq/
  22  * In-depth documentation and a comprehensive tag index is available in the
  23    Textpattern user documentation at http://docs.textpattern.io
  24  * You can get support and information via:
  25     Forum:    http://forum.textpattern.com/
  26     Twitter:  http://textpattern.com/@textpattern
  27     Google+:  http://textpattern.com/+
  28     Facebook: http://textpattern.com/facebook
  29  
  30  
  31  == Installation ==
  32  
  33  * Extract the Textpattern files to your site (in the web root, subdomain or
  34    subdirectory). The top-level index.php file should reside in this directory,
  35    as should the /textpattern/ and /rpc/ directories.
  36  * Ensure the top-level .htaccess file is transferred to your site. The file is
  37    hidden by default on some operating systems, including OS X/macOS. Most FTP
  38    clients and IDEs have an option to show these hidden files. Otherwise, you can
  39    temporarily show hidden files in OS X/macOS by using the Terminal.app - follow
  40    these instructions:
  41      http://textpattern.com/hidden-files-osx
  42  * Create or verify the existence of a working MySQL database with valid username
  43    and password. From Textpattern 4.6.0, the MySQL database user requires INDEX
  44    permissions in addition to standard SELECT, CREATE, UPDATE, ALTER, etc
  45    permissions. See the system requirements for a complete list:
  46      http://textpattern.com/system-requirements
  47  * Load /textpattern/setup/ (or /subdirectory/textpattern/setup/) in your
  48    browser to start the installation process and follow the directions.
  49  * When the installation is complete, remove the /textpattern/setup/ directory
  50    from your site.
  51  * If you are running Textpattern on an Apache web server, you can rename
  52    /files/.htaccess-dist to /files/.htaccess to prohibit direct URL access to
  53    your uploaded files. Thus the only route to these files becomes through the
  54    /file_download/ directory. It is recommended you consider employing this
  55    feature. Alternatively, move your /files/ directory out of a web-accessible
  56    location. Once moved, you can specify your new directory location from the
  57    Textpattern Admin Preferences (Admin -> Preferences -> Admin).
  58  
  59  
  60  == IMPORTANT ==
  61  
  62  * Check back regularly at http://textpattern.com/ to see if an update is
  63    available. Updates are as painless as possible, often fixing important bugs
  64    and/or security-related issues as well as offering additional features and
  65    functionality.
  66  
  67  
  68  == Upgrading ==
  69  
  70  * Confirm your web server meets or exceeds the Textpattern system requirements:
  71      http://textpattern.com/system-requirements
  72  * Log out of the Textpattern admin-side.
  73  * Verify the existence of a known-good Textpattern database and file backup.
  74  * Ensure your MySQL database user has INDEX permissions in addition to any
  75    permissions previously granted.
  76  * Replace the top-level index.php, css.php and .htaccess files, everything in
  77    the /rpc/ directory and everything in the /textpattern/ directory (except
  78    /textpattern/config.php and the /textpattern/setup directory) with the
  79    corresponding files in this distribution.
  80    When uploading the /textpattern/ directory, ensure you merge its contents with
  81    your existing site to preserve any custom files in your existing installation.
  82    Note: css.php and /rpc/ may not exist if the installed version of
  83    Textpattern is prior to 4.2.0.
  84  * It is recommended that the browser cache is cleared to ensure the newer files
  85    are used in preference to the older files.
  86  * Log in to the Textpattern admin-side. The upgrade script(s) will run
  87    automatically. Check the diagnostics (Admin -> Diagnostics) to confirm the
  88    correct Textpattern version number is displayed and whether there are any
  89    errors.
  90    NOTE: Upgrades from versions prior to 4.2.0 will present warnings or errors
  91    upon the first login to the admin-side. These may include:
  92      Unknown column 'user_name' in 'where clause' select name,
  93      val from txp_prefs where prefs_id=1 AND user_name='' in
  94      /path/to/your/site/textpattern/lib/txplib_db.php on line xx
  95      Undefined variable: language in
  96      /path/to/your/site/textpattern/index.php at line xx
  97      Undefined variable: gmtoffset in
  98      /path/to/your/site/textpattern/update/_to_4.2.0.php at line xx
  99    This is expected behaviour. The messages will disappear with subsequent
 100    navigation in the admin-side.
 101  * Verify all preference settings (Admin -> Preferences).
 102  
 103  
 104  == Additional Resources ==
 105  
 106  * There are additional resources for the default front-side theme, such as
 107    Sass preprocessor files, available at:
 108      http://textpattern.com/default-theme/tree/master/
 109  
 110  
 111  == Contributing ==
 112  
 113  Want to help out with the development of Textpattern CMS? Please refer to the
 114  Contributing documentation http://docs.textpattern.io/development/contributing
 115  for full details.