strk/friendica
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Reformatted

Browse source
This commit is contained in:
Silke Meyer 2015-04-18 19:31:19 +02:00
parent 584c2e4a58
commit 02f03c0313
1 changed files with 85 additions and 77 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

160
doc/Install.md
View file

@ -1,118 +1,126 @@
Friendica Installation Friendica Installation
=============== ===============
We've tried very hard to ensure that Friendica will run on commodity hosting platforms - such as those used to host Wordpress blogs and Drupal websites. But be aware that Friendica is more than a simple web application. It is a complex communications system which more closely resembles an email server than a web server. For reliability and performance, messages are delivered in the background and are queued for later delivery when sites are down. This kind of functionality requires a bit more of the host system than the typical blog. Not every PHP/MySQL hosting provider will be able to support Friendica. Many will. But **please** review the requirements and confirm these with your hosting provider prior to installation. We've tried very hard to ensure that Friendica will run on commodity hosting platforms - such as those used to host Wordpress blogs and Drupal websites.
But be aware that Friendica is more than a simple web application.
It is a complex communications system which more closely resembles an email server than a web server.
For reliability and performance, messages are delivered in the background and are queued for later delivery when sites are down.
This kind of functionality requires a bit more of the host system than the typical blog.
Not every PHP/MySQL hosting provider will be able to support Friendica.
Many will.
But **please** review the requirements and confirm these with your hosting provider prior to installation.
Also if you encounter installation issues, please let us know via the forums at http://groups.google.com/group/friendica or file an issue at http://bugs.friendica.com . Please be as clear as you can about your operating environment and provide as much detail as possible about any error messages you may see, so that we can prevent it from happening in the future. Due to the large variety of operating systems and PHP platforms in existence we may have only limited ability to debug your PHP installation or acquire any missing modules - but we will do our best to solve any general code issues. Also if you encounter installation issues, please let us know via the [helper]() or the [developer]() forum or [file an issue](https://github.com/friendica/friendica/issues).
Please be as clear as you can about your operating environment and provide as much detail as possible about any error messages you may see, so that we can prevent it from happening in the future.
Due to the large variety of operating systems and PHP platforms in existence we may have only limited ability to debug your PHP installation or acquire any missing modules - but we will do our best to solve any general code issues.
Before you begin: Choose a domain name or subdomain name for your server. Put some thought into this - because changing it after installation 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. Before you begin: Choose a domain name or subdomain name for your server.
Put some thought into this. Changing it after installation 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 Requirements
- Apache with mod-rewrite enabled and "Options All" so you can use a ---
local .htaccess file
- PHP 5.2+. The later the better. You'll need 5.3 for encryption of key exchange conversations. On a Windows environment, 5.2+ might not work as the function dns_get_record() is only available with version 5.3. * Apache with mod-rewrite enabled and "Options All" so you can use a local .htaccess file
- PHP *command line* access with register_argc_argv set to true in the * PHP 5.2+. The later the better. You'll need 5.3 for encryption of key exchange conversations. On a Windows environment, 5.2+ might not work as the function dns_get_record() is only available with version 5.3.
php.ini file * PHP *command line* access with register_argc_argv set to true in the php.ini file
- curl, gd, mysql, hash and openssl extensions * curl, gd, mysql, hash and openssl extensions
- some form of email server or email gateway such that PHP mail() works * some form of email server or email gateway such that PHP mail() works
- mcrypt (optional; used for server-to-server message encryption) * mcrypt (optional; used for server-to-server message encryption)
* Mysql 5.x
* the ability to schedule jobs with cron (Linux/Mac) or Scheduled Tasks (Windows) (Note: other options are presented in Section 7 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 not be as convenient to use and have not been thoroughly tested.
* If your hosting provider doesn't allow Unix shell access, you might have trouble getting everything to work.
- Mysql 5.x Installation procedure
---
- ability to schedule jobs with cron (Linux/Mac) or Scheduled Tasks ###Get Friendica
(Windows) [Note: other options are presented in Section 7 of this document]
- Installation into a top-level domain or sub-domain (without a Unpack the Friendica files into the root of your web server document area.
directory/path component in the URL) is preferred. Directory paths will If you are able to do so, we recommend using git to clone the source repository rather than to use a packaged tar or zip file.
not be as convenient to use and have not been thoroughly tested. This makes the software much easier to update.
The Linux command to clone the repository into a directory "mywebsite" would be
git clone https://github.com/friendica/friendica.git mywebsite
[Dreamhost.com offers all of the necessary hosting features at a Make sure the folder *view/smarty3* exists and is writable by the webserver user
reasonable price. If your hosting provider doesn't allow Unix shell access,
you might have trouble getting everything to work.]
2. Unpack the Friendica files into the root of your web server document area. mkdir view/smarty3
chmod 777 view/smarty3
- If you are able to do so, we recommend using git to clone the source repository rather than to use a packaged tar or zip file. This makes the software much easier to update. The Linux command to clone the repository into a directory "mywebsite" would be Get the addons by going into your website folder.
`git clone https://github.com/friendica/friendica.git mywebsite` cd mywebsite
- and then you can pick up the latest changes at any time with Clone the addon repository (separately):
`git pull` git clone https://github.com/friendica/friendica-addons.git addon
- make sure folder *view/smarty3* exists and is writable by webserver If you copy the directory tree to your webserver, make sure that you also copy .htaccess - as "dot" files are often hidden and aren't normally copied.
`mkdir view/smarty3` ###Create a database
`chmod 777 view/smarty3` Create an empty database and note the access details (hostname, username, password, database name).
- For installing addons ###Run the installer
- First you should be **on** your website folder Point your web browser to the new site and follow the instructions.
Please note any error messages and correct these before continuing.
`cd mywebsite` *If* the automated installation fails for any reason, check the following:
- Then you should clone the addon repository (separtely) * Does ".htconfig.php" exist? If not, edit htconfig.php and change the system settings. Rename to .htconfig.php
* Is the database is populated? If not, import the contents of "database.sql" with phpmyadmin or mysql command line.
`git clone https://github.com/friendica/friendica-addons.git addon` At this point visit your website again, and register your personal account.
- For keeping the addon tree updated, you should be on you addon tree and issue a git pull
`cd mywebsite/addon`
`git pull`
- If you copy the directory tree to your webserver, make sure
that you also copy .htaccess - as "dot" files are often hidden
and aren't normally copied.
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 note any error messages and correct these before continuing.
5. *If* the automated installation fails for any reason, check the following:
- ".htconfig.php" exists ... If not, edit htconfig.php and change system settings. Rename
to .htconfig.php
- Database is populated. ... 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.
Registration errors should all be recoverable automatically. Registration errors should all be recoverable automatically.
If you get any *critical* failure at this point, it generally indicates the If you get any *critical* failure at this point, it generally indicates the database was not installed correctly.
database was not installed correctly. You might wish to move/rename You might wish to move/rename .htconfig.php to another name and empty (called 'dropping') the database tables, so that you can start fresh.
.htconfig.php to another name and empty (called 'dropping') the database
tables, so that you can start fresh.
7. Set up a cron job or scheduled task to run the poller once every 5-10 ###Set up the poller
minutes in order to perform background processing. Example:
`cd /base/directory; /path/to/php include/poller.php` Set up a cron job or scheduled task to run the poller once every 5-10 minutes in order to perform background processing.
Example:
cd /base/directory; /path/to/php include/poller.php
Change "/base/directory", and "/path/to/php" as appropriate for your situation. 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 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: 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 include/poller.php
You can generally find the location of PHP by executing "which php". If you You can generally find the location of PHP by executing "which php".
have troubles with this section please contact your hosting provider for If you run into trouble with this section please contact your hosting provider for assistance.
assistance. Friendica will not work correctly if you cannot perform this step. Friendica will not work correctly if you cannot perform this step.
Alternative: You may be able to use the 'poormancron' plugin to perform this step Alternative: You may be able to use the 'poormancron' plugin to perform this step.
if you are using a recent Friendica release. To do this, edit the file ".htconfig.php" To do this, edit the file ".htconfig.php" and look for a line describing your plugins.
and look for a line describing your plugins. On a fresh installation, it will look like On a fresh installation, it will look like this:
`$a->config['system']['addon'] = 'js_upload';` $a->config['system']['addon'] = 'js_upload';
This indicates the "js_upload" addon module is enabled. You may add additional It indicates the "js_upload" addon module is enabled.
addons/plugins using this same line in the configuration file. Change it to read 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';` $a->config['system']['addon'] = 'js_upload,poormancron';
and save your changes. and save your changes.
Updating your installation with git
---
You can get the latest changes at any time with
cd mywebsite
git pull
The addon tree has to be updated separately like so:
cd mywebsite/addon
git pull