]> git.mxchange.org Git - friendica.git/blobdiff - INSTALL.txt
remove duplicate tag in atom response
[friendica.git] / INSTALL.txt
index 70e4f24efdee8e44259cce5ed37606ebad91d5d2..32de0309c3d0224e772a88bce90a55c23714684e 100644 (file)
@@ -12,6 +12,11 @@ blog. Not every PHP/MySQL hosting provider will be able to support Friendika.
 Many will. But please review the requirements and confirm these with your 
 hosting provider prior to installation.
 
+Before you begin: Choose a domain name or subdomain name for your server.
+Put some thought into this - because changing it is currently not-supported.
+Things will break, and some of your friends may have difficulty communicating
+with you. We plan to address this limitation in a future release. 
 
 1. Requirements
        - Apache with mod-rewrite enabled and "Options All" so you can use a 
@@ -22,14 +27,14 @@ exchange conversations
 encryption support
                - PHP *command line* access with register_argc_argv set to true in the 
 php.ini file
-               - curl, gd, mysql, and openssl extensions
+               - curl, gd, mysql, mbstring, and openssl extensions
                - some form of email server or email gateway such that PHP mail() works
                - mcrypt (optional; used for end-to-end message encryption)
 
        - Mysql 5.x
 
        - ability to schedule jobs with cron (Linux/Mac) or Scheduled Tasks
-(Windows)
+(Windows) [Note: other options are presented in Section 8 of this document]
 
        - Installation into a top-level domain or sub-domain (without a 
 directory/path component in the URL) is preferred. Directory paths will
@@ -48,10 +53,15 @@ you might have trouble getting everything to work.]
 3. Create an empty database and note the access details (hostname, username, 
 password, database name).
 
-4. Visit your website with a web browser and follow the instructions. Please 
+
+4. If you know in advance that it will be impossible for the web server to 
+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.
 
-5. *If* the automated installation fails for any reason, check the following:
+6. *If* the automated installation fails for any reason, check the following:
 
        - ".htconfig.php" exists 
                If not, edit htconfig.php and change system settings. Rename 
@@ -60,7 +70,7 @@ to .htconfig.php
                If not, import the contents of "database.sql" with phpmyadmin 
 or mysql command line
 
-6. At this point visit your website again, and register your personal account. 
+7. At this point visit your website again, and register your personal account. 
 Registration errors should all be recoverable automatically. 
 If you get any *critical* failure at this point, it generally indicates the
 database was not installed correctly. You might wish to move/rename 
@@ -73,7 +83,7 @@ tables, so that you can start fresh.
 ****************************************************************************
 ****************************************************************************
 
-7. 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 poller 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
@@ -89,3 +99,18 @@ 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 
 assistance. Friendika will not work correctly if you cannot perform this step.
   
+Alternative: You may be able to use the 'poormancron' plugin to perform this
+step if you are using a recent Friendika release. To do this, edit the file 
+".htconfig.php" and look for a line describing your plugins. On a fresh 
+installation, it will look like
+
+$a->config['system']['addon'] = 'js_upload';
+
+This indicates the "js_upload" addon module is enabled. You may add additional 
+addons/plugins using this same line in the configuration file. Change it to 
+read
+
+$a->config['system']['addon'] = 'js_upload,poormancron';
+
+and save your changes.
+