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.
We offer a manual and an automatic installation.
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.
+
+But **please** review the [requirements](#Requirements) and confirm these with your hosting provider prior to installation.
## Support
If you encounter installation issues, please let us know via the [helper](http://forum.friendi.ca/profile/helpers) or the [developer](https://forum.friendi.ca/profile/developers) forum or [file an issue](https://github.com/friendica/friendica/issues).
## Prerequisites
* Choose a domain name or subdomain name for your server. Put some thought into this. While changing it after installation is supported, things still might break.
-* Setup HTTPS on your host.
+* Setup HTTPS on your domain.
### Requirements
-* Apache with mod-rewrite enabled and "Options All" so you can use a local .htaccess file
+* Apache with mod-rewrite enabled and "Options All" so you can use a local `.htaccess` file
* PHP 7+ (PHP 7.1+ is recommended for performance and official support)
* PHP *command line* access with register_argc_argv set to true in the php.ini file
* Curl, GD, PDO, MySQLi, hash, xml, zip and OpenSSL extensions
Unpack the Friendica files into the root of your web server document area.
-If you copy the directory tree to your webserver, make sure that you also copy
-`.htaccess-dist` - as "dot" files are often hidden and aren't normally copied.
+If you copy the directory tree to your webserver, make sure that you also copy `.htaccess-dist` - as "dot" files are often hidden and aren't normally copied.
**OR**
The Linux commands to clone the repository into a directory "mywebsite" would be
- git clone https://github.com/friendica/friendica.git -b master mywebsite
+ git clone https://github.com/friendica/friendica.git -b stable mywebsite
cd mywebsite
bin/composer.phar install --no-dev
Clone the addon repository (separately):
- git clone https://github.com/friendica/friendica-addons.git -b master addon
+ git clone https://github.com/friendica/friendica-addons.git -b stable addon
If you want to use the development version of Friendica you can switch to the develop branch in the repository by running
Friendica needs the permission to create and delete fields and tables in its own database.
-Please check the [troubleshooting](#troubleshooting) section if running on MySQ 5.7.17 or newer.
+Please check the [troubleshooting](#Troubleshooting) section if running on MySQL 5.7.17 or newer.
### Option A: Run the installer
-Point your web browser to the new site and follow the instructions.
+Before you point your web browser to the new site you need to copy `.htaccess-dist` to `.htaccess` for Apache installs.
+Follow the instructions.
Please note any error messages and correct these before continuing.
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.
#### B.1: Config file
-You can use a prepared config file like [local-sample.config.php](config/local-sample.config.php).
+You can use a prepared config file like [local-sample.config.php](/config/local-sample.config.php).
Navigate to the main Friendica directory and execute the following command:
### Prepare .htaccess file
-Copy `.htaccess-dist` to `.htaccess` (be careful under Windows) to have working mod-rewrite again. If you have installed Friendica into a sub directory, like /friendica/ set this path in RewriteBase accordingly.
+Copy `.htaccess-dist` to `.htaccess` (be careful under Windows) to have working mod-rewrite again. If you have installed Friendica into a sub directory, like */friendica/* set this path in `RewriteBase` accordingly.
Example:
cp .htacces-dist .htaccess
-*Note*: Do **not** rename the .htaccess-dist file as it is tracked by GIT and renaming will cause a dirty working directory.
+*Note*: Do **not** rename the `.htaccess-dist` file as it is tracked by GIT and renaming will cause a dirty working directory.
### Verify the "host-meta" page is working
-Friendica should respond automatically to important addresses under the /.well-known/ rewrite path.
-One critical URL would look like, for example, https://example.com/.well-known/host-meta
+Friendica should respond automatically to important addresses under the */.well-known/* rewrite path.
+One critical URL would look like, for example: https://example.com/.well-known/host-meta
It must be visible to the public and must respond with an XML file that is automatically customized to your site.
If that URL is not working, it is possible that some other software is using the /.well-known/ path.
This is a severe configuration issue that prevents server to server communication."
Another common error related to host-meta is the "Invalid profile URL."
-Check for a .well-known directory that did not come with Friendica.
+Check for a `.well-known` directory that did not come with Friendica.
The preferred configuration is to remove the directory, however this is not always possible.
If there is any /.well-known/.htaccess file, it could interfere with this Friendica core requirement.
You should remove any RewriteRules from that file, or remove that whole file if appropriate.
Change "/base/directory", and "/path/to/php" as appropriate for your situation.
-#### cron job for Worker
+#### cron job for worker
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:
### 500 Internal Error
This could be the result of one of our Apache directives not being supported by your version of Apache. Examine your apache server logs.
-You might remove the line "Options -Indexes" from the .htaccess file if you are using a Windows server as this has been known to cause problems.
+You might remove the line "Options -Indexes" from the `.htaccess` file if you are using a Windows server as this has been known to cause problems.
Also check your file permissions. Your website and all contents must generally be world-readable.
It is likely that your web server reported the source of the problem in its error log files.
>
> This is obvious as soon as you notice that the friendica-cron uses `proc_open`
> to execute PHP scripts that also use `proc_open`, but it took me quite some time to find that out.
-> I hope this saves some time for other people using suhosin with function blacklists.
+> I hope this saves some time for other people using suhosin with function blocklists.
### Unable to create all mysql tables on MySQL 5.7.17 or newer
projects / friendica.git / blobdiff