Teknik is a suite of services with attractive and functional interfaces. https://www.teknik.io/
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

INSTALL 8.5KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231
  1. INTRODUCTION
  2. ============
  3. This file describes the basic steps to install Roundcube Webmail on your
  4. web server. For additional information, please also consult the project's
  5. wiki page at http://trac.roundcube.net/wiki
  6. REQUIREMENTS
  7. ============
  8. * The Apache, Lighttpd, Cherokee or Hiawatha web server
  9. * .htaccess support allowing overrides for DirectoryIndex
  10. * PHP Version 5.2.1 or greater including
  11. - PCRE, DOM, JSON, XML, Session, Sockets (required)
  12. - PHP Data Objects (PDO) with driver for either MySQL, PostgreSQL or SQLite (required)
  13. Note: MySQL database driver requires PHP 5.3 or newer.
  14. - Libiconv, Zip (recommended)
  15. - Fileinfo, Mcrypt, mbstring (optional)
  16. * PEAR packages distributed with Roundcube or external:
  17. - Mail_Mime 1.8.1 or newer
  18. - Mail_mimeDecode 1.5.5 or newer
  19. - Net_SMTP (latest from https://github.com/pear/Net_SMTP/)
  20. - Net_IDNA2 0.1.1 or newer
  21. - Auth_SASL 1.0.6 or newer
  22. * php.ini options (see .htaccess file):
  23. - error_reporting E_ALL & ~E_NOTICE (or lower)
  24. - memory_limit > 16MB (increase as suitable to support large attachments)
  25. - file_uploads enabled (for attachment upload features)
  26. - session.auto_start disabled
  27. - zend.ze1_compatibility_mode disabled
  28. - suhosin.session.encrypt disabled
  29. - mbstring.func_overload disabled
  30. - magic_quotes_runtime disabled
  31. - magic_quotes_sybase disabled
  32. * PHP compiled with OpenSSL to connect to IMAPS and to use the spell checker
  33. * A MySQL (4.0.8 or newer), PostgreSQL, MS SQL Server (2005 or newer) database engine
  34. or SQLite support in PHP
  35. * One of the above databases with permission to create tables
  36. * An SMTP server (recommended) or PHP configured for mail delivery
  37. INSTALLATION
  38. ============
  39. 1. Decompress and put this folder somewhere inside your document root
  40. 2. Make sure that the following directories (and the files within)
  41. are writable by the webserver
  42. - /temp
  43. - /logs
  44. 3. Create a new database and a database user for Roundcube (see DATABASE SETUP)
  45. 4. Point your browser to http://url-to-roundcube/installer/
  46. 5. Follow the instructions of the install script (or see MANUAL CONFIGURATION)
  47. 6. After creating and testing the configuration, remove the installer directory
  48. 7. Done!
  49. CONFIGURATION HINTS
  50. ===================
  51. Roundcube writes internal errors to the 'errors' log file located in the logs
  52. directory which can be configured in config/main.inc.php. If you want ordinary
  53. PHP errors to be logged there as well, enable the 'php_value error_log' line
  54. in the .htaccess file and set the path to the log file accordingly.
  55. By default the session_path settings of PHP are not modified by Roundcube.
  56. However if you want to limit the session cookies to the directory where
  57. Roundcube resides you can uncomment and configure the according line
  58. in the .htaccess file.
  59. DATABASE SETUP
  60. ==============
  61. Note: Database for Roundcube must use UTF-8 character set.
  62. * MySQL
  63. -------
  64. Setting up the mysql database can be done by creating an empty database,
  65. importing the table layout and granting the proper permissions to the
  66. roundcube user. Here is an example of that procedure:
  67. # mysql
  68. > CREATE DATABASE roundcubemail /*!40101 CHARACTER SET utf8 COLLATE utf8_general_ci */;
  69. > GRANT ALL PRIVILEGES ON roundcubemail.* TO roundcube@localhost
  70. IDENTIFIED BY 'password';
  71. > quit
  72. # mysql roundcubemail < SQL/mysql.initial.sql
  73. Note 1: 'password' is the master password for the roundcube user. It is strongly
  74. recommended you replace this with a more secure password. Please keep in
  75. mind: You need to specify this password later in 'config/db.inc.php'.
  76. * SQLite
  77. --------
  78. Versions of sqlite database engine older than 3 aren't supported.
  79. Database file and structure is created automatically by Roundcube.
  80. Make sure your configuration points to some file location and that the
  81. webserver can write to the file and the directory containing the file.
  82. * PostgreSQL
  83. ------------
  84. To use Roundcube with PostgreSQL support you have to follow these
  85. simple steps, which have to be done as the postgres system user (or
  86. which ever is the database superuser):
  87. $ createuser roundcube
  88. $ createdb -O roundcube -E UNICODE roundcubemail
  89. $ psql roundcubemail
  90. roundcubemail =# ALTER USER roundcube WITH PASSWORD 'the_new_password';
  91. roundcubemail =# \c - roundcube
  92. roundcubemail => \i SQL/postgres.initial.sql
  93. All this has been tested with PostgreSQL 8.x and 7.4.x. Older
  94. versions don't have a -O option for the createdb, so if you are
  95. using that version you'll have to change ownership of the DB later.
  96. * Microsoft SQL Server
  97. ----------------------
  98. Language/locale of the database must be set to us_english (1033). More info
  99. on this at http://trac.roundcube.net/ticket/1488918.
  100. Database cleaning
  101. -----------------
  102. To keep your database slick and clean we recommend to periodically execute
  103. bin/cleandb.sh which finally removes all records that are marked as deleted.
  104. Best solution is to install a cronjob running this script daily.
  105. MANUAL CONFIGURATION
  106. ====================
  107. First of all, rename the files config/*.inc.php.dist to config/*.inc.php.
  108. You can then change these files according to your environment and your needs.
  109. Details about the config parameters can be found in the config files.
  110. See http://trac.roundcube.net/wiki/Howto_Install for even more guidance.
  111. You can also modify the default .htaccess file. This is necessary to
  112. increase the allowed size of file attachments, for example:
  113. php_value upload_max_filesize 2M
  114. UPGRADING
  115. =========
  116. If you already have a previous version of Roundcube installed,
  117. please refer to the instructions in UPGRADING guide.
  118. OPTIMISING
  119. ==========
  120. There are two forms of optimisation here, compression and caching, both aimed
  121. at increasing an end user's experience using Roundcube Webmail. Compression
  122. allows the static web pages to be delivered with less bandwidth. The index.php
  123. of Roundcube Webmail already enables compression on its output. The settings
  124. below allow compression to occur for all static files. Caching sets HTTP
  125. response headers that enable a user's web client to understand what is static
  126. and how to cache it.
  127. The caching directives used are:
  128. * Etags - sets at tag so the client can request is the page has changed
  129. * Cache-control - defines the age of the page and that the page is 'public'
  130. This enables clients to cache javascript files that don't have private
  131. information between sessions even if using HTTPS. It also allows proxies
  132. to share the same cached page between users.
  133. * Expires - provides another hint to increase the lifetime of static pages.
  134. For more information refer to RFC 2616.
  135. Side effects:
  136. -------------
  137. These directives are designed for production use. If you are using this in
  138. a development environment you may get horribly confused if your webclient
  139. is caching stuff that you changed on the server. Disabling the expires
  140. parts below should save you some grief.
  141. If you are changing the skins, it is recommended that you copy content to
  142. a different directory apart from 'default'.
  143. Apache:
  144. -------
  145. To enable these features in apache the following modules need to be enabled:
  146. * mod_deflate
  147. * mod_expires
  148. * mod_headers
  149. The optimisation is already included in the .htaccess file in the top
  150. directory of your installation.
  151. If you are using Apache version 2.2.9 and later, in the .htaccess file
  152. change the 'append' word to 'merge' for a more correct response. Keeping
  153. as 'append' shouldn't cause any problems though changing to merge will
  154. eliminate the possibility of duplicate 'public' headers in Cache-control.
  155. Lighttpd:
  156. ---------
  157. With Lightty the addition of Expire: tags by mod_expire is incompatible with
  158. the addition of "Cache-control: public". Using Cache-control 'public' is
  159. used below as it is assumed to give a better caching result.
  160. Enable modules in server.modules:
  161. "mod_setenv"
  162. "mod_compress"
  163. Mod_compress is a server side cache of compressed files to improve its performance.
  164. $HTTP["host"] == "www.example.com" {
  165. static-file.etags = "enable"
  166. # http://redmine.lighttpd.net/projects/lighttpd/wiki/Etag.use-mtimeDetails
  167. etag.use-mtime = "enable"
  168. # http://redmine.lighttpd.net/projects/lighttpd/wiki/Docs:ModSetEnv
  169. $HTTP["url"] =~ "^/roundcubemail/(plugins|skins|program)" {
  170. setenv.add-response-header = ( "Cache-Control" => "public, max-age=2592000")
  171. }
  172. # http://redmine.lighttpd.net/projects/lighttpd/wiki/Docs:ModCompress
  173. # set compress.cache-dir to somewhere outside the docroot.
  174. compress.cache-dir = var.statedir + "/cache/compress"
  175. compress.filetype = ("text/plain", "text/html", "text/javascript", "text/css", "text/xml", "image/gif", "image/png")
  176. }