Doco - some clean up to install - keep politics out of it, 80 columnise it and

whitespace.
This commit is contained in:
Thomas Willingham 2014-10-22 20:22:37 +01:00
parent fa7b90d051
commit 77fb1c2ee6

View File

@ -1,4 +1,3 @@
Red Matrix Installation
We've tried very hard to ensure that the Red Matrix will run on commodity
@ -46,15 +45,15 @@ allow you to use a non browser-valid certificate.
This restriction is incorporated because public posts from you may for example
contain references to images on your own hub. If your certificate is not known
by the internet browser of users they get a warning message complaining about
some security issues. Although these complains are not the real truth - there
are no security issues with your encryption! - the users may be confused,
nerved or even worse may become scared about Red Matrix having security issues.
the invalid certificate.
Free "browser-valid" certificates are available from providers such as StartSSL.
If you do NOT use SSL, there may be a delay of up to a minute for the initial
install script - while we check the SSL port to see if anything responds there.
When communicating with new sites, Red Matrix always attempts connection on the
SSL port first, before falling back to a less secure connection.
SSL port first, before falling back to a less secure connection. If you do not
use SSL, your webserver must not listen on port 443 at all.
1. Requirements
- Apache with mod-rewrite enabled and "AllowOverride All" so you can use a
@ -63,10 +62,11 @@ local .htaccess file
- PHP 5.3+. The later the better.
- PHP *command line* access with register_argc_argv set to true in the
php.ini file - and with no hosting provider restrictions on the use of exec()
and proc_open().
php.ini file - and with no hosting provider restrictions on the use of
exec() and proc_open().
- curl, gd (with at least jpeg and png support), mysqli, mbstring, mcrypt, and openssl extensions. The imagick extension is not required but desirable.
- curl, gd (with at least jpeg and png support), mysqli, mbstring, mcrypt,
and openssl extensions. The imagick extension is not required but desirable.
- some form of email server or email gateway such that PHP mail() works
@ -79,14 +79,14 @@ directory/path component in the URL) is REQUIRED.
2. Unpack the RedMatrix 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 - 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.
- 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
- 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
git clone https://github.com/friendica/red.git mywebsite
@ -94,7 +94,8 @@ directory/path component in the URL) is REQUIRED.
git pull
- make sure folders *store/[data]/smarty3* and *store* exist and are writable by webserver
- make sure folders *store/[data]/smarty3* and *store* exist and are
writable by the webserver
mkdir -p "store/[data]/smarty3"
@ -118,17 +119,16 @@ directory/path component in the URL) is REQUIRED.
git clone https://github.com/friendica/red-addons.git addon
- For keeping the addon tree updated, you should be on you addon tree and issue a git pull
- For keeping the addon tree updated, you should be on you addon tree and
issue a git pull
cd mywebsite/addon
git pull
3. Create an empty database and note the access details (hostname, username,
password, database name).
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.
@ -174,10 +174,10 @@ one shown, substituting for your unique paths and settings:
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. The RedMatrix will not work correctly if you cannot perform this step.
assistance. RedMatrix will not work correctly if you cannot perform this step.
You should also be sure that $a->config['system']['php_path'] is set correctly, it should
look like (changing it to the correct PHP location)
You should also be sure that $a->config['system']['php_path'] is set correctly,
it should look like (changing it to the correct PHP location)
$a->config['system']['php_path'] = '/usr/local/php53/bin/php';
@ -194,8 +194,8 @@ $a->config['system']['php_path'] = '/usr/local/php53/bin/php';
"System is currently unavailable. Please try again later"
#####################################################################
Check your database settings. It usually means your database could not
be opened or accessed. If the database resides on the same machine, check that
Check your database settings. It usually means your database could not be
opened or accessed. If the database resides on the same machine, check that
the database server name is the word "localhost".
#####################################################################
@ -228,8 +228,8 @@ http://yoursitenamehere.com/test.out
This file should be blocked. You should get a permission denied message.
If you see the word "test" your Apache configuration is not allowing
your .htaccess file to be used (there are rules in this file to block access
If you see the word "test" your Apache configuration is not allowing your
.htaccess file to be used (there are rules in this file to block access
to any file with .out at the end, as these are typically used for system logs).
Make certain the .htaccess file exists and is readable by everybody, then