Commit 116be739 by postActiv

Merge branch 'bashrc/install-documentation' into 'master'

Improved Debian install

See merge request !39
2 parents 432cbbd4 aaa3d46f
......@@ -29,9 +29,9 @@ run correctly.
- PHP 5.5+ For newer versions, some functions that are used may be
disabled by default, such as the pcntl_* family. See the
section on 'Queues and daemons' for more information.
- MySQL 5+ postActiv supports MySQL 5.5+ by default. MariaDB should
also work in theory but can run into some obscure errors.
postgreSQL support is currently in development
- MySQL 5+ postActiv supports MySQL 5.5+ by default. MariaDB 10+
should also work in theory but can run into some obscure
errors. postgreSQL support is currently in development
- Web server Apache, lighttpd and nginx will all work. CGI mode is
recommended and also some variant of 'suexec' (or a
proper setup php-fpm pool)
......@@ -66,6 +66,21 @@ The above package names are for Debian based systems. In the case of
Arch Linux, PHP is compiled with support for most extensions but they
require manual enabling in the relevant php.ini file (mostly php5-gmp).
Debian install
--------------
Here's how to set the system up on a new installation of Debian stable. You will need a domain name capable of getting a LetsEncrypt certificate and also to forward ports 80 and 443 to your server machine. Then run:
``` bash
su
apt-get -yq install git
git clone https://git.postactiv.com/postActiv/postActiv.git /var/www/postactiv
cd /var/www/postactiv
./scripts/debian_install.sh [mariadb password] [username] [password] [domain] [email address]
```
This installs everything needed, including the web server, TLS certificate and database.
Better performance
------------------
......@@ -118,7 +133,7 @@ Installing from the Archive Bundle
This will often make your postActiv instance available in the postactiv
path of your server, like "http://example.net/gnusocial". "social" or
"blog" might also be good path names. If you know how to configure
"blog" might also be good path names. If you know how to configure
virtual hosts on your web server, you can try setting up
"http://social.example.net/" or the like.
......@@ -188,7 +203,7 @@ Installing from the Archive Bundle
8. You should now be able to navigate to your social site's main directory
and see the "Public Timeline", which will probably be empty. You can
now register new user, post some notices, edit your profile, etc.
Installing using git-scm
------------------------
Using git-scm to install the software will allow you to keep much more easily
......@@ -211,7 +226,7 @@ It should go without saying, this method requires git installed to use.
3. With the key loaded, make switch to the directory that you want to install
postActiv into. For example, /var/www/postactiv
4. Clone the git repository into this directory with the following command:
git clone git@git.postactiv.com:postActiv/postActiv.git
......@@ -289,7 +304,7 @@ Log Filtering
By default, all of the various log messages are enabled in your postActiv log
location. This allows you to identify any install problems very easily, since
the output is quite verbose by default to aid in troubleshooting installs gone
wrong. Once you know your site is running properly however, most of this
wrong. Once you know your site is running properly however, most of this
information is probably superfluous. You can use the LogFilter module to filter
out the LOG_DEBUG and LOG_INFO level messages so you only see errors in the
postActiv log by adding the following near the bottom of config.php:
......@@ -325,7 +340,7 @@ your server (like lighttpd or nginx).
1. See the instructions for each respective webserver software:
* For Apache, inspect the "htaccess.sample" file and save it as
".htaccess" after making any necessary modifications. Our sample
file is well commented.
file is well commented.
* For lighttpd, inspect the lighttpd.conf.example file and apply the
appropriate changes in your virtualhost configuration for lighttpd.
* For nginx, inspect the nginx.conf.sample file and apply the appropriate
......@@ -375,7 +390,7 @@ A postActiv node can be configured as "private", which means it will not
federate with other nodes in the network. It is not a recommended method
of using postActiv and we cannot at the current state of development
guarantee that there are no leaks (what a public network sees as features,
private sites will likely see as bugs).
private sites will likely see as bugs).
Private nodes are however an easy way to easily setup collaboration and
image sharing within a workgroup or a smaller community where federation
......@@ -534,7 +549,7 @@ in CentOS, you can install the required environment with:
For other distributions, the package names may change.
Once Redis is set up and confirmed to be working, you will need to set the
Once Redis is set up and confirmed to be working, you will need to set the
following in your config.php:
To enable redis queue:
......@@ -643,4 +658,4 @@ Upgrading
Upgrading is strongly recommended to stay up to date with security fixes
and new features. For instructions on how to upgrade postActiv code,
please see the UPGRADE file.
please see the UPGRADE file.
\ No newline at end of file
......@@ -20,7 +20,7 @@ Some other files to review:
Information on using GNU social can be found in the "doc" subdirectory or in
the "help" section on-line, or you can contact maiyannah on the fediverse at
@maiyannah@community.highlandarrow.com or her email at
@maiyannah@community.highlandarrow.com or her email at
<maiyannah.bishop@postactiv.com>
## About
......@@ -112,15 +112,15 @@ The minimum requirements to run postActiv are the following:
* Web server: You must have either an Apache, nginx, or Litespeed web server
configured with PHP support to serve up postActiv. We recommend Apache, but
nginx is also well-supported.
## Installation
Detailed installation information is in INSTALLING.md, but in basic, you will
Detailed installation information is in INSTALL.md, but in basic, you will
want to download the branch archive of your choice, unzip it to a web-accessible
directory, and then run the Install.php file, which will guide you through
further setup. You will want to have a database available for postActiv, of
course.
The postActiv repository also contains MoonMan's SensitiveContent as a
The postActiv repository also contains MoonMan's SensitiveContent as a
submodule, which allows users to block the display of attachments on posts
that are tagged "NSFW". If you wish to install this plugin, you will have to
download the branch of your choice, and then in /plugins/SensitiveContent
......@@ -129,9 +129,9 @@ course.
## Configuration
The main configuration file for postActiv (excepting configurations for
dependency software or some plugins) is config.php in your postActiv root
directory. If you edit any other file in the directory, like
lib/default.php (where most of the defaults are defined), you will lose
dependency software or some plugins) is config.php in your postActiv root
directory. If you edit any other file in the directory, like
lib/default.php (where most of the defaults are defined), you will lose
your configuration options in any upgrade, so you will want to make changes
in the config.php file.
......@@ -184,7 +184,7 @@ To keep it up-to-date, use 'git pull'. Watch for conflicts!
There are several ways to get more information about GNU social.
* Following us on the Fediverse --
* Following us on the Fediverse --
<https://community.highlandarrow.com/postActiv>
* psotActiv has a bug tracker for any defects you may find, or ideas for
......@@ -208,4 +208,4 @@ The following is a list of developers who've contributed to postActiv:
* Moonman
See CREDITS.md for a full listing of contributors to upstream sources such as
GNU social or StatusNet.
\ No newline at end of file
GNU social or StatusNet.
Markdown is supported
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!