The following software packages are *required* for this software to
run correctly.
-- PHP 5.4+ 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.
-- MariaDB 5+ GNU Social uses, by default, a MariaDB server for data
- storage. Versions 5.x and 10.x have both reportedly
- worked well. It is also possible to run MySQL 5.5+.
-- 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)
- NOTE: mod_rewrite or its equivalent is extremely useful.
+- PHP 5.6+ PHP7.x is also supported.
+- MariaDB 5+ MariaDB 10.x is also supported.
+- Web server Apache, lighttpd and nginx will all work, see sample
+ configuration files in the web root. Please use PHP-FPM
+ and configure mod_rewrite (or equivalent) for an optimal
+ experience.
Your PHP installation must include the following PHP extensions for a
functional setup of GNU Social:
- php5-mysqlnd The native driver for PHP5 MariaDB connections. If you
use MySQL, 'php5-mysql' or 'php5-mysqli' may be enough.
-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).
+Or, for PHP7, some or all of these will be necessary. PHP7 works and on
+the development servers we are successful running PHP7.2. This is a good
+list of PHP modules you will want installed with PHP7:
+ php7.0-bcmath
+ php7.0-curl
+ php7.0-exif
+ php7.0-gd
+ php7.0-intl
+ php7.0-mbstring
+ php7.0-mysql
+ php7.0-opcache
+ php7.0-readline
+ php7.0-xmlwriter
+
+NOTE: In Arch Linux, at least PHP5 requires manual enabling in the
+relevant php.ini for some modules, most notably 'gmp'.
Better performance
------------------
- opcache Improves performance a _lot_. Included in PHP, must be
enabled manually in php.ini for most distributions. Find
and set at least: opcache.enable=1
-- mailparse Efficient parsing of email requires this extension.
- Submission by email or SMS-over-email uses this.
-- sphinx A client for the sphinx server, an alternative to MySQL
- or Postgresql fulltext search. You will also need a
- Sphinx server to serve the search queries.
- gettext For multiple languages. Default on many PHP installs;
will be emulated if not present.
- exif For thumbnails to be properly oriented.
-You may also experience better performance from your site if you configure
-a PHP cache/accelerator. Most distributions come with "opcache" support.
-Enable it in your php.ini where it is documented together with its settings.
-
Installation
============
will enable "Fancy URL" support, which you can read more about if you
scroll down a bit in this document.
-3. Make your target directory writeable by the Web server.
+3. Make your target directory writeable by the Web server, please note
+ however that 'a+w' will give _all_ users write access and securing the
+ webserver is not within the scope of this document.
chmod a+w /var/www/gnusocial/
- On some systems, this will probably work:
+ On some systems, this will work as a more secure alternative:
chgrp www-data /var/www/gnusocial/
chmod g+w /var/www/gnusocial/
that user's default group instead. As a last resort, you can create
a new group like "gnusocial" and add the Web server's user to the group.
-4. You should also take this moment to make your avatar, background, and
- file subdirectories writeable by the Web server. An insecure way to do
- this is:
-
- chmod a+w /var/www/gnusocial/avatar
- chmod a+w /var/www/gnusocial/background
- chmod a+w /var/www/gnusocial/file
-
- You can also make the avatar, background, and file directories
- writeable by the Web server group, as noted above.
-
-5. Create a database to hold your site data. Something like this
+4. Create a database to hold your site data. Something like this
should work (you will be prompted for your database password):
mysqladmin -u "root" -p create social
a tool like phpMyAdmin to create a database. Check your hosting
service's documentation for how to create a new MariaDB database.)
-6. Create a new database account that GNU Social will use to access the
+5. Create a new database account that GNU Social will use to access the
database. If you have shell access, this will probably work from the
MariaDB shell:
to your preferred new database username and password. You may want to
test logging in to MariaDB as this new user.
-7. In a browser, navigate to the GNU Social install script; something like:
+6. In a browser, navigate to the GNU Social install script; something like:
https://social.example.net/install.php
install program will configure your site and install the initial,
almost-empty database.
-8. You should now be able to navigate to your social site's main directory
+7. 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.
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 and other webservers, we gladly accept contributions of
+ * For nginx, inspect the nginx.conf.sample file and apply the appropriate
+ changes.
+ * For other webservers, we gladly accept contributions of
server configuration examples.
2. Assuming your webserver is properly configured and have its settings
### OpportunisticQM plugin
This plugin is enabled by default. It tries its best to do background
-job during regular HTTP requests, like API or HTML pages calls.
+jobs during regular HTTP requests, like API or HTML pages calls.
Since queueing system is enabled by default, notices to be broadcasted
will be stored, by default, into DB (table queue_item).
-Each time it can, OpportunisticQM will try to handle some of them.
+Whenever it has time, OpportunisticQM will try to handle some of them.
This is a good solution whether you:
projects / quix0rs-gnu-social.git / blobdiff