keith/friendica
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Merge pull request #4582 from tobiasd/20180311-doc

Browse source 
installation docs
This commit is contained in:
Hypolite Petovan 2018-03-11 12:35:12 -04:00 committed by GitHub
commit e793160795
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 13 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
INSTALL.txt
View file

@ -129,24 +129,16 @@ assistance. Friendica will not work correctly if you cannot perform this step.
You should also be sure that $a->config['php_path'] is set correctly, it should You should also be sure that $a->config['php_path'] is set correctly, it should
look like (changing it to the correct PHP location) look like (changing it to the correct PHP location)
$a->config['php_path'] = '/usr/local/php53/bin/php' $a->config['php_path'] = '/usr/local/php56/bin/php'
Alternative: You may be able to use the 'poormancron' addon to perform this
step if you are using a recent Friendica release. 'poormancron' may result in
perfomance and memory issues and is only suitable for small sites with one or
two users and a handful of contacts. To do this, edit the file
".htconfig.php" and look for a line describing your addons. On a fresh
installation, it will look like
$a->config['system']['addon'] = 'js_upload'; Alternative: If you cannot use a cron job as described above, you can use
the frontend worker and an external cron service to trigger the execution
of the worker script. You can enable the frontend worker after the installation
from the admin panel of your node and call
This indicates the "js_upload" addon module is enabled. You may add additional https://example.com/worker
addons using this same line in the configuration file. Change it to
read
$a->config['system']['addon'] = 'js_upload,poormancron'; with the service of your choice.
and save your changes.
9. (Recommended) Set up a backup plan 9. (Recommended) Set up a backup plan

11
doc/Install.md
View file

@ -38,7 +38,7 @@ Requirements
Installation procedure Installation procedure
--- ---
###Get Friendica ### Get Friendica
Unpack the Friendica files into the root of your web server document area. Unpack the Friendica files into the root of your web server document area.
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. 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.
@ -64,7 +64,7 @@ Clone the addon repository (separately):
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. 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.
###Create a database ### Create a database
Create an empty database and note the access details (hostname, username, password, database name). Create an empty database and note the access details (hostname, username, password, database name).
@ -79,7 +79,7 @@ In this case find the [mysqld] section in your my.cnf file and add the line :
Restart mysql and you should be fine. Restart mysql and you should be fine.
###Run the installer ### Run the installer
Point your web browser to the new site and follow the instructions. Point your web browser to the new site and follow the instructions.
Please note any error messages and correct these before continuing. Please note any error messages and correct these before continuing.
@ -96,7 +96,7 @@ 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. If you get any *critical* failure at this point, it generally indicates the database was not installed correctly.
You might wish to move/rename .htconfig.php to another name and empty (called 'dropping') the database tables, so that you can start fresh. You might wish to move/rename .htconfig.php to another name and empty (called 'dropping') the database tables, so that you can start fresh.
###Set up the worker ### Set up the worker
Set up a cron job or scheduled task to run the worker once every 5-10 minutes in order to perform background processing. Set up a cron job or scheduled task to run the worker once every 5-10 minutes in order to perform background processing.
Example: Example:
@ -118,7 +118,8 @@ If it is not possible to set up a cron job then please activate the "frontend wo
Once you have installed Friendica and created an admin account as part of the process, you can access the admin panel of your installation and do most of the server wide configuration from there Once you have installed Friendica and created an admin account as part of the process, you can access the admin panel of your installation and do most of the server wide configuration from there
###Set up a backup plan ### Set up a backup plan
Bad things will happen. Bad things will happen.
Let there be a hardware failure, a corrupted database or whatever you can think of. 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 yourself a backup plan. So once the installation of your Friendica node is done, you should make yourself a backup plan.