]> git.mxchange.org Git - friendica.git/blob - INSTALL.txt
DFRN: Entry import could work now, first steps for mails
[friendica.git] / INSTALL.txt
1
2 Friendica Installation
3
4 We've tried very hard to ensure that Friendica will run on commodity hosting 
5 platforms - such as those used to host Wordpress blogs and Drupal websites. 
6 But be aware that Friendica is more than a simple web application. It is a 
7 complex communications system which more closely resembles an email server 
8 than a web server. For reliability and performance, messages are delivered in
9 the background and are queued for later delivery when sites are down. This
10 kind of functionality requires a bit more of the host system than the typical
11 blog. Not every PHP/MySQL hosting provider will be able to support Friendica. 
12 Many will. But please review the requirements and confirm these with your 
13 hosting provider prior to installation.
14
15 Before you begin: Choose a domain name or subdomain name for your server.
16 Put some thought into this - because changing it is currently not-supported.
17 Things will break, and some of your friends may have difficulty communicating
18 with you. We plan to address this limitation in a future release. Also decide
19 if you wish to connect with members of the Diaspora network, as this will 
20 impact the installation requirements.
21
22 Decide if you will use SSL and obtain an SSL cert. Communications with the
23 Diaspora network MAY require both SSL AND an SSL cert signed by a CA which is 
24 recognised by the major browsers. Friendica will work with self-signed certs
25 but Diaspora communication may not. For best results, install your cert PRIOR
26 to installing Friendica and when visiting your site for the initial 
27 installation in step 5, please use the https: link. (Use the http: or non-SSL 
28 link if your cert is self-signed). 
29  
30
31 1. Requirements
32         - Apache with mod-rewrite enabled and "Options All" so you can use a 
33 local .htaccess file
34
35         - PHP 5.2+. The later the better. PHP 5.3 is required for communications 
36 with the Diaspora network and improved security.
37
38                 - PHP *command line* access with register_argc_argv set to true in the 
39 php.ini file [or see 'poormancron' in section 8]
40
41                 - curl, gd (with at least jpeg support), mysql, mbstring, mcrypt, and openssl extensions
42
43                 - some form of email server or email gateway such that PHP mail() works
44
45         - Mysql 5.x
46
47         - ability to schedule jobs with cron (Linux/Mac) or Scheduled Tasks
48 (Windows) [Note: other options are presented in Section 8 of this document]
49
50         - Installation into a top-level domain or sub-domain (without a 
51 directory/path component in the URL) is preferred. This is REQUIRED if
52 you wish to communicate with the Diaspora network.
53
54
55         - For alternative server configurations (such as Nginx server and MariaDB 
56         database engine), refer to the wiki at https://github.com/friendica/friendica/wiki
57
58 2. Unpack the Friendica files into the root of your web server document area.
59
60         - If you copy the directory tree to your webserver, make sure
61         that you also copy .htaccess - as "dot" files are often hidden 
62         and aren't normally copied.
63
64 3. Create an empty database and note the access details (hostname, username, 
65 password, database name).
66
67     - Friendica needs the permission to create and delete fields and tables in its own database.
68
69
70 4. If you know in advance that it will be impossible for the web server to 
71 write or create files in your web directory, create an empty file called 
72 .htconfig.php and make it writable by the web server.
73
74 5. Visit your website with a web browser and follow the instructions. Please 
75 note any error messages and correct these before continuing. If you are using
76 SSL with a known signature authority (recommended), use the https: link to your
77 website. If you are using a self-signed cert or no cert, use the http: link. 
78
79 6. *If* the automated installation fails for any reason, check the following:
80
81         - ".htconfig.php" exists 
82                 If not, edit htconfig.php and change system settings. Rename 
83 to .htconfig.php
84         -  Database is populated.
85                 If not, import the contents of "database.sql" with phpmyadmin 
86 or mysql command line
87
88 7. At this point visit your website again, and register your personal account. 
89 Registration errors should all be recoverable automatically. 
90 If you get any *critical* failure at this point, it generally indicates the
91 database was not installed correctly. You might wish to move/rename 
92 .htconfig.php to another name and empty (called 'dropping') the database 
93 tables, so that you can start fresh.  
94
95 ****************************************************************************
96 ****************************************************************************
97 ********          THIS NEXT STEP IS IMPORTANT!!!!                ***********
98 ****************************************************************************
99 ****************************************************************************
100
101 8. Set up a cron job or scheduled task to run the poller once every 5-10 
102 minutes to pick up the recent "public" postings of your friends. Example:
103
104         cd /base/directory; /path/to/php include/poller.php
105
106 Change "/base/directory", and "/path/to/php" as appropriate for your situation.
107
108 If you are using a Linux server, run "crontab -e" and add a line like the 
109 one shown, substituting for your unique paths and settings:
110
111 */10 * * * *    cd /home/myname/mywebsite; /usr/bin/php include/poller.php
112
113 You can generally find the location of PHP by executing "which php". If you 
114 have troubles with this section please contact your hosting provider for 
115 assistance. Friendica will not work correctly if you cannot perform this step.
116
117 You should also be sure that $a->config['php_path'] is set correctly, it should
118 look like (changing it to the correct PHP location)
119
120 $a->config['php_path'] = '/usr/local/php53/bin/php'
121   
122 Alternative: You may be able to use the 'poormancron' plugin to perform this
123 step if you are using a recent Friendica release. 'poormancron' may result in
124 perfomance and memory issues and is only suitable for small sites with one or
125 two users and a handful of contacts. To do this, edit the file 
126 ".htconfig.php" and look for a line describing your plugins. On a fresh 
127 installation, it will look like
128
129 $a->config['system']['addon'] = 'js_upload';
130
131 This indicates the "js_upload" addon module is enabled. You may add additional 
132 addons/plugins using this same line in the configuration file. Change it to 
133 read
134
135 $a->config['system']['addon'] = 'js_upload,poormancron';
136
137 and save your changes.
138
139
140  
141 #####################################################################
142
143                 If things don't work...
144
145 #####################################################################
146
147
148 #####################################################################
149 - If you get the message 
150         "System is currently unavailable. Please try again later"
151 #####################################################################
152         
153         Check your database settings. It usually means your database could not 
154 be opened or accessed. If the database resides on the same machine, check that
155 the database server name is "localhost". 
156
157 #####################################################################
158 - 500 Internal Error
159 #####################################################################
160
161         This could be the result of one of our Apache directives not being 
162 supported by your version of Apache. Examine your apache server logs.
163         You might remove the line "Options -Indexes" from the .htaccess file if 
164 you are using a Windows server as this has been known to cause problems.
165 Also check your file permissions. Your website and all contents must generally 
166 be world-readable.
167
168         It is likely that your web server reported the source of the problem in
169 its error log files. Please review these system error logs to determine what 
170 caused the problem. Often this will need to be resolved with your hosting
171 provider or (if self-hosted) your web server configuration. 
172
173 #####################################################################
174 - 400 and 4xx "File not found" errors
175 #####################################################################
176
177         First check your file permissions. Your website and all contents must 
178 generally be world-readable.
179
180         Ensure that mod-rewite is installed and working, and that your
181 .htaccess file is being used. To verify the latter, create a file test.out
182 containing the word "test" in the top directory of Friendica, make it world 
183 readable and point your web browser to
184
185 http://yoursitenamehere.com/test.out
186
187         This file should be blocked. You should get a permission denied message.
188
189         If you see the word "test" your Apache configuration is not allowing
190 your .htaccess file to be used (there are rules in this file to block access
191 to any file with .out at the end, as these are typically used for system logs).
192
193         Make certain the .htaccess file exists and is readable by everybody, then 
194 look for the existence of "AllowOverride None" in the Apache server 
195 configuration for your site. This will need to be changed to 
196 "AllowOverride All".  
197
198         If you do not see the word "test", your .htaccess is working, but it is 
199 likely that mod-rewrite is not installed in your web server or is not working.
200
201         On most flavour of Linux,
202
203 % a2enmod rewrite
204 % /etc/init.d/apache2 restart
205
206         Consult your hosting provider, experts on your particular Linux 
207 distribution or (if Windows) the provider of your Apache server software if 
208 you need to change either of these and can not figure out how. There is 
209 a lot of help available on the web. Google "mod-rewrite" along with the 
210 name of your operating system distribution or Apache package (if using 
211 Windows).
212
213   
214 #####################################################################
215 - If you are unable to write the file .htconfig.php during installation 
216 due to permissions issues:
217 #####################################################################
218
219         create an empty file with that name and give it world-write permission.
220 For Linux:
221
222 % touch .htconfig.php
223 % chmod 777 .htconfig.php
224
225 Retry the installation. As soon as the database has been created, 
226
227 ******* this is important *********
228
229 % chmod 755 .htconfig.php
230
231 #####################################################################
232 - Some configurations with "suhosin" security are configured without
233 an ability to run external processes. Friendica requires this ability.
234 Following are some notes provided by one of our members.
235 #####################################################################
236
237 On my server I use the php protection system Suhosin
238 [http://www.hardened-php.net/suhosin/]. One of the things it does is to block
239 certain functions like proc_open, as configured in /etc/php5/conf.d/suhosin.ini:
240
241  suhosin.executor.func.blacklist = proc_open, ...
242
243 For those sites like Friendica that really need these functions they can be
244 enabled, e.g. in /etc/apache2/sites-available/friendica:
245
246  <Directory /var/www/friendica/>
247   php_admin_value suhosin.executor.func.blacklist none
248   php_admin_value suhosin.executor.eval.blacklist none
249  </Directory>
250
251 This enables every function for Friendica if accessed via browser, but not for
252 the cronjob that is called via php command line. I attempted to enable it for
253 cron by using something like
254
255  */10 * * * * cd /var/www/friendica/friendica/ && sudo -u www-data /usr/bin/php
256 -d suhosin.executor.func.blacklist=none -d suhosin.executor.eval.blacklist=none
257 -f include/poller.php
258
259 This worked well for simple test cases, but the friendica-cron still failed with
260 a fatal error:
261 suhosin[22962]: ALERT - function within blacklist called: proc_open() (attacker
262 'REMOTE_ADDR not set', file '/var/www/friendica/friendica/boot.php', line 1341)
263
264 After a while I noticed, that include/poller.php calls further php script via
265 proc_open. These scripts themselves also use proc_open and fail, because they
266 are NOT called with -d suhosin.executor.func.blacklist=none.
267
268 So the simple solution is to put the correct parameters into .htconfig.php:
269  // Location of PHP command line processor
270  $a->config['php_path'] = '/usr/bin/php -d suhosin.executor.func.blacklist=none
271 -d suhosin.executor.eval.blacklist=none';
272
273
274 This is obvious as soon as you notice that the friendica-cron uses proc_open to
275 execute php-scripts that also use proc_open, but it took me quite some time to
276 find that out. I hope this saves some time for other people using suhosin with
277 function blacklists.