Implement saved_searches/list API

[friendica.git] / INSTALL.txt

diff --git a/INSTALL.txt b/INSTALL.txt
index a96c9fd5a25524fa85fa4ef0f352f6bc610198c8..bc0f4824a7c29ad53249f0bddf97c759b42c0cb3 100644 (file)
--- a/INSTALL.txt
+++ b/INSTALL.txt
@@ -37,7 +37,7 @@ local .htaccess file
                - PHP *command line* access with register_argc_argv set to true in the 
 php.ini file [or see 'poormancron' in section 8]
 
-               - curl, gd (with at least jpeg support), mysql, mbstring, mcrypt, and openssl extensions
+               - curl, gd (with at least jpeg support), mysql, mbstring, xml and openssl extensions
 
                - some form of email server or email gateway such that PHP mail() works
 
@@ -71,9 +71,14 @@ write or create files in your web directory, create an empty file called
 .htconfig.php and make it writable by the web server.
 
 5. Visit your website with a web browser and follow the instructions. Please 
-note any error messages and correct these before continuing. If you are using
-SSL with a known signature authority (recommended), use the https: link to your
-website. If you are using a self-signed cert or no cert, use the http: link. 
+note any error messages and correct these before continuing.
+
+If you are using SSL with a known signature authority (recommended), use the
+https: link to your website. If you are using a self-signed cert or no cert,
+use the http: link.
+
+If you need to specify a port for the connection to the database, you can do
+so in the host name setting for the database.
 
 6. *If* the automated installation fails for any reason, check the following:
 
@@ -97,17 +102,17 @@ tables, so that you can start fresh.
 ****************************************************************************
 ****************************************************************************
 
-8. Set up a cron job or scheduled task to run the poller once every 5-10 
+8. Set up a cron job or scheduled task to run the worker once every 5-10 
 minutes to pick up the recent "public" postings of your friends. Example:
 
-       cd /base/directory; /path/to/php include/poller.php
+       cd /base/directory; /path/to/php scripts/worker.php
 
 Change "/base/directory", and "/path/to/php" as appropriate for your situation.
 
 If you are using a Linux server, run "crontab -e" and add a line like the 
 one shown, substituting for your unique paths and settings:
 
-*/10 * * * *   cd /home/myname/mywebsite; /usr/bin/php include/poller.php
+*/10 * * * *   cd /home/myname/mywebsite; /usr/bin/php scripts/worker.php
 
 You can generally find the location of PHP by executing "which php". If you 
 have troubles with this section please contact your hosting provider for 
@@ -135,7 +140,17 @@ $a->config['system']['addon'] = 'js_upload,poormancron';
 
 and save your changes.
 
-9. (Optional) Reverse-proxying and HTTPS
+9. (Recommended) Set up a backup plan
+
+Bad things will happen. Let there be a hardware failure, a corrupted
+database or whatever you can think of. So once the installation of your
+Friendica node is done, you should make yoursef a backup plan.
+
+The most important file is the `.htconfig.php` file in the base directory.
+As it stores all your data, you should also have a recent dump of your
+Friendica database at hand, should you have to recover your node.
+
+10. (Optional) Reverse-proxying and HTTPS
 
 Friendica looks for some well-known HTTP headers indicating a reverse-proxy
 terminating an HTTPS connection. While the standard from RFC 7239 specifies
@@ -270,14 +285,14 @@ cron by using something like
 
  */10 * * * * cd /var/www/friendica/friendica/ && sudo -u www-data /usr/bin/php
 -d suhosin.executor.func.blacklist=none -d suhosin.executor.eval.blacklist=none
--f include/poller.php
+-f scripts/worker.php
 
 This worked well for simple test cases, but the friendica-cron still failed with
 a fatal error:
 suhosin[22962]: ALERT - function within blacklist called: proc_open() (attacker
 'REMOTE_ADDR not set', file '/var/www/friendica/friendica/boot.php', line 1341)
 
-After a while I noticed, that include/poller.php calls further php script via
+After a while I noticed, that scripts/worker.php calls further php script via
 proc_open. These scripts themselves also use proc_open and fail, because they
 are NOT called with -d suhosin.executor.func.blacklist=none.
 
@@ -293,16 +308,16 @@ find that out. I hope this saves some time for other people using suhosin with
 function blacklists.
 
 ########################################################################
-Unable to create alle mysql tables on MySQL 5.7.17 or newer
+Unable to create all mysql tables on MySQL 5.7.17 or newer
 #######################################################################
 
 If the setup fails to create all the database tables and/or manual
-creation from the command line failes, with this error : 
+creation from the command line fails, with this error: 
 
 ERROR 1067 (42000) at line XX: Invalid default value for 'created' 
 
 You need to adjust your my.cnf and add the following setting under 
-the [mysqld] setion : 
+the [mysqld] section : 
 
 sql_mode = '';