+TABLE OF CONTENTS
+=================
+* Prerequisites
+ - PHP modules
+ - Better performance
+* Installation
+ - Getting it up and running
+ - Fancy URLs
+ - Sphinx
+ - SMS
+ - Queues and daemons
+ - Themes
+ - Translation
+ - Backups
+ - Private
+
Prerequisites
=============
+PHP modules
+-----------
+
The following software packages are *required* for this software to
run correctly.
-- PHP 5.3+ For newer versions, some functions that are used may be
+- 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.x GNU Social uses, by default, a MariaDB server for data
+- 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.x.
+ 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)
Your PHP installation must include the following PHP extensions for a
functional setup of GNU Social:
-- Curl Fetching files by HTTP.
-- XMLWriter For formatting XML and HTML output.
-- mysqlnd The native driver for PHP5 MySQL/MariaDB connections.
-- GD Image manipulation (scaling).
-- mbstring For handling Unicode (UTF-8) encoded strings.
-- bcmath or gmp For Salmon signatures (part of OStatus)
+- openssl (compiled in for Debian, enabled manually in Arch Linux)
+- php5-curl Fetching files by HTTP.
+- php5-gd Image manipulation (scaling).
+- php5-gmp For Salmon signatures (part of OStatus).
+- php5-json For WebFinger lookups and more.
+- php5-mysqlnd The native driver for PHP5 MariaDB connections. If you
+ use MySQL, 'mysql' or 'mysqli' may work.
+
+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).
Better performance
------------------
For some functionality, you will also need the following extensions:
-- memcache A client for the memcached server, which caches database
- information in volatile memory. This is important for
- adequate performance on high-traffic sites. You will
- also need a memcached server to store the data in.
+- 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
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 install
-a PHP bytecode cache/accelerator. Currently the recommended cache module
-is 'xcache', which after installation (php5-xcache) can be enabled in
-your site's config.php with:
-
- addPlugin('XCache');
-
-External libraries
-------------------
-
-A number of external PHP libraries are used to provide basic
-functionality and optional functionality for your system. For your
-convenience, they are available in the "extlib" directory of this
-package, and you do not have to download and install them. However,
-you may want to keep them up-to-date with the latest upstream version,
-and the URLs are listed here for your convenience.
-
-- DB_DataObject http://pear.php.net/package/DB_DataObject
-- Validate http://pear.php.net/package/Validate
-- OpenID from OpenIDEnabled (not the PEAR version!). We decided
- to use the openidenabled.com version since it's more widely
- implemented, and seems to be better supported.
- http://openidenabled.com/php-openid/
-- PEAR DB. Although this is an older data access system (new
- packages should probably use PHP DBO), the OpenID libraries
- depend on PEAR DB so we use it here, too. DB_DataObject can
- also use PEAR MDB2, which may give you better performance
- but won't work with OpenID.
- http://pear.php.net/package/DB
-- OAuth.php from http://oauth.googlecode.com/svn/code/php/
-- markdown.php from http://michelf.com/projects/php-markdown/
-- PEAR Mail, for sending out mail notifications
- http://pear.php.net/package/Mail
-- PEAR Net_SMTP, if you use the SMTP factory for notifications
- http://pear.php.net/package/Net_SMTP
-- PEAR Net_Socket, if you use the SMTP factory for notifications
- http://pear.php.net/package/Net_Socket
-- XMPPHP, the follow-up to Class.Jabber.php. Probably the best XMPP
- library available for PHP. http://xmpphp.googlecode.com/. Note that
- as of this writing the version of this library that is available in
- the extlib directory is *significantly different* from the upstream
- version (patches have been submitted). Upgrading to the upstream
- version may render your StatusNet site unable to send or receive XMPP
- messages.
-- Facebook library. Used for the Facebook application.
-- PEAR Validate is used for URL and email validation.
-- Console_GetOpt for parsing command-line options.
- predecessor to OStatus.
-- HTTP_Request2, a library for making HTTP requests.
-- PEAR Net_URL2 is an HTTP_Request2 dependency.
-
-A design goal of StatusNet is that the basic Web functionality should
-work on even the most restrictive commercial hosting services.
-However, additional functionality, such as receiving messages by
-Jabber/GTalk, require that you be able to run long-running processes
-on your account. In addition, posting by email or from SMS require
-that you be able to install a mail filter in your mail server.
+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, it is documented there together with its settings.
Installation
============
-Installing the basic StatusNet Web component is relatively easy,
-especially if you've previously installed PHP/MySQL packages.
+Getting it up and running
+-------------------------
+
+Installing the basic GNU Social web component is relatively easy,
+especially if you've previously installed PHP/MariaDB packages.
1. Unpack the tarball you downloaded on your Web server. Usually a
command like this will work:
- tar zxf statusnet-1.1.1.tar.gz
+ tar zxf gnusocial-*.tar.gz
- ...which will make a statusnet-1.1.1 subdirectory in your current
+ ...which will make a gnusocial-x.y.z subdirectory in your current
directory. (If you don't have shell access on your Web server, you
may have to unpack the tarball on your local computer and FTP the
files to the server.)
2. Move the tarball to a directory of your choosing in your Web root
directory. Usually something like this will work:
- mv statusnet-1.1.1 /var/www/statusnet
+ mv gnusocial-x.y.z /var/www/gnusocial
+
+ This will often make your GNU Social instance available in the gnusocial
+ path of your server, like "http://example.net/gnusocial". "social" or
+ "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.
- This will make your StatusNet instance available in the statusnet path of
- your server, like "http://example.net/statusnet". "microblog" or
- "statusnet" might also be good path names. If you know how to
- configure virtual hosts on your web server, you can try setting up
- "http://micro.example.net/" or the like.
+ If you have "rewrite" support on your webserver, and you should,
+ then please enable this in order to make full use of your site. This
+ 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.
- chmod a+w /var/www/statusnet/
+ chmod a+w /var/www/gnusocial/
On some systems, this will probably work:
- chgrp www-data /var/www/statusnet/
- chmod g+w /var/www/statusnet/
+ chgrp www-data /var/www/gnusocial/
+ chmod g+w /var/www/gnusocial/
If your Web server runs as another user besides "www-data", try
that user's default group instead. As a last resort, you can create
- a new group like "statusnet" and add the Web server's user to the group.
+ 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/statusnet/avatar
- chmod a+w /var/www/statusnet/background
- chmod a+w /var/www/statusnet/file
+ 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 microblog data. Something like this
+5. Create a database to hold your site data. Something like this
should work:
- mysqladmin -u "username" --password="password" create statusnet
+ mysqladmin -u "root" --password="rootpassword" create gnusocial
- Note that StatusNet must have its own database; you can't share the
- database with another program. You can name it whatever you want,
+ Note that GNU Social should have its own database; you should not share
+ the database with another program. You can name it whatever you want,
though.
(If you don't have shell access to your server, you may need to use
- a tool like PHPAdmin to create a database. Check your hosting
- service's documentation for how to create a new MySQL database.)
+ 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 StatusNet will use to access the
+6. 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
- MySQL shell:
+ MariaDB shell:
- GRANT ALL on statusnet.*
- TO 'statusnetuser'@'localhost'
- IDENTIFIED BY 'statusnetpassword';
+ GRANT ALL on gnusocial.*
+ TO 'gnusocial'@'localhost'
+ IDENTIFIED BY 'agoodpassword';
- You should change 'statusnetuser' and 'statusnetpassword' to your preferred new
- username and password. You may want to test logging in to MySQL as
- this new user.
+ You should change the user identifier 'gnusocial' and 'agoodpassword'
+ 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 StatusNet install script; something like:
+7. In a browser, navigate to the GNU Social install script; something like:
- http://yourserver.example.com/statusnet/install.php
+ http://social.example.net/install.php
Enter the database connection information and your site name. The
install program will configure your site and install the initial,
almost-empty database.
-8. You should now be able to navigate to your microblog's main directory
- and see the "Public Timeline", which will be empty. If not, magic
- has happened! You can now register a new user, post some notices,
- edit your profile, etc. However, you may want to wait to do that stuff
- if you think you can set up "fancy URLs" (see below), since some
- URLs are stored in the database.
+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.
Fancy URLs
----------
-By default, StatusNet will use URLs that include the main PHP program's
-name in them. For example, a user's home profile might be
-found at:
+By default, GNU Social will use URLs that include the main PHP program's
+name in them. For example, a user's home profile might be found at:
- http://example.org/statusnet/index.php/statusnet/fred
+ http://example.net/gnusocial/index.php/gnusocial/fred
On certain systems that don't support this kind of syntax, they'll
look like this:
- http://example.org/statusnet/index.php?p=statusnet/fred
+ http://example.net/gnusocial/index.php?p=gnusocial/fred
It's possible to configure the software so it looks like this instead:
- http://example.org/statusnet/fred
+ http://example.net/gnusocial/fred
These "fancy URLs" are more readable and memorable for users. To use
fancy URLs, you must either have Apache 2.x with .htaccess enabled and
mod_rewrite enabled, -OR- know how to configure "url redirection" in
-your server.
+your server (like lighttpd or nginx).
1. Copy the htaccess.sample file to .htaccess in your StatusNet
- directory. Note: if you have control of your server's httpd.conf or
- similar configuration files, it can greatly improve performance to
- import the .htaccess file into your conf file instead. If you're
- not sure how to do it, you may save yourself a lot of headache by
- just leaving the .htaccess file.
+ directory.
2. Change the "RewriteBase" in the new .htaccess file to be the URL path
- to your StatusNet installation on your server. Typically this will
- be the path to your StatusNet directory relative to your Web root.
+ to your GNU Social installation on your server. Typically this will
+ be the path to your GNU Social directory relative to your Web root.
+ If you are installing it in the root directory, leave it as '/'.
-3. Add or uncomment or change a line in your config.php file so it says:
+3. Add, uncomment or change a line in your config.php file so it says:
$config['site']['fancy'] = true;
You should now be able to navigate to a "fancy" URL on your server,
like:
- http://example.net/statusnet/main/register
+ http://example.net/gnusocial/main/register
If you changed your HTTP server configuration, you may need to restart
the server first.
-If it doesn't work, double-check that AllowOverride for the StatusNet
+If it doesn't work, double-check that AllowOverride for the GNU Social
directory is 'All' in your Apache configuration file. This is usually
/etc/httpd.conf, /etc/apache/httpd.conf, or (on Debian and Ubuntu)
/etc/apache2/sites-available/default. See the Apache documentation for
$config['mail']['domain'] = 'yourdomain.example.net';
-At this point, post-by-email and post-by-SMS-gateway should work. Note
-that if your mail server is on a different computer from your email
-server, you'll need to have a full installation of StatusNet, a working
-config.php, and access to the StatusNet database from the mail server.
-
-XMPP
-----
-
-XMPP (eXtended Message and Presence Protocol, <http://xmpp.org/>) is the
-instant-messenger protocol that drives Jabber and GTalk IM. You can
-distribute messages via XMPP using the system below; however, you
-need to run the XMPP incoming daemon to allow incoming messages as
-well.
-
-1. You may want to strongly consider setting up your own XMPP server.
- Ejabberd, OpenFire, and JabberD are all Open Source servers.
- Jabber, Inc. provides a high-performance commercial server.
-
-2. You must register a Jabber ID (JID) with your new server. It helps
- to choose a name like "update@example.com" or "notice" or something
- similar. Alternately, your "update JID" can be registered on a
- publicly-available XMPP service, like jabber.org or GTalk.
-
- StatusNet will not register the JID with your chosen XMPP server;
- you need to do this manually, with an XMPP client like Gajim,
- Telepathy, or Pidgin.im.
-
-3. Configure your site's XMPP variables, as described below in the
- configuration section.
-
-On a default installation, your site can broadcast messages using
-XMPP. Users won't be able to post messages using XMPP unless you've
-got the XMPP daemon running. See 'Queues and daemons' below for how
-to set that up. Also, once you have a sizable number of users, sending
-a lot of SMS, OStatus, and XMPP messages whenever someone posts a message
-can really slow down your site; it may cause posting to timeout.
-
-NOTE: stream_select(), a crucial function for network programming, is
-broken on PHP 5.2.x less than 5.2.6 on amd64-based servers. We don't
-work around this bug in StatusNet; current recommendation is to move
-off of amd64 to another server.
-
-Public feed
------------
-
-You can send *all* messages from your social networking site to a
-third-party service using XMPP. This can be useful for providing
-search, indexing, bridging, or other cool services.
-
-To configure a downstream site to receive your public stream, add
-their "JID" (Jabber ID) to your config.php as follows:
- $config['xmpp']['public'][] = 'downstream@example.net';
-
-(Don't miss those square brackets at the end.) Note that your XMPP
-broadcasting must be configured as mentioned above. Although you can
-send out messages at "Web time", high-volume sites should strongly
-consider setting up queues and daemons.
Queues and daemons
------------------
Some activities that StatusNet needs to do, like broadcast OStatus, SMS,
-and XMPP messages, can be 'queued' and done by off-line bots instead.
-For this to work, you must be able to run long-running offline
-processes, either on your main Web server or on another server you
-control. (Your other server will still need all the above
-prerequisites, with the exception of Apache.) Installing on a separate
-server is probably a good idea for high-volume sites.
+XMPP messages and TwitterBridge operations, can be 'queued' and done by
+off-line bots instead.
+
+Two mechanisms are available to achieve offline operations:
+
+* New embedded OpportunisticQM plugin, which is enabled by default
+* Legacy queuedaemon script, which can be enabled via config file.
+
+### 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.
+
+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.
+
+This is a good solution whether you:
+
+* have no access to command line (shared hosting)
+* do not want to deal with long-running PHP processes
+* run a low traffic GNU social instance
+
+In other case, you really should consider enabling the queuedaemon for
+performance reasons. Background daemons are necessary anyway if you wish
+to use the Instant Messaging features such as communicating via XMPP.
+
+### queuedaemon
+
+If you want to use legacy queuedaemon, you must be able to run
+long-running offline processes, either on your main Web server or on
+another server you control. (Your other server will still need all the
+above prerequisites, with the exception of Apache.) Installing on a
+separate server is probably a good idea for high-volume sites.
1. You'll need the "CLI" (command-line interface) version of PHP
installed on whatever server you use.
server!), set the following variable:
$config['queue']['enabled'] = true;
+ $config['queue']['daemon'] = true;
You may also want to look at the 'daemon' section of this file for
more daemon options. Note that if you set the 'user' and/or 'group'
* queuedaemon.php - polls for queued items for inbox processing and
pushing out to OStatus, SMS, XMPP, etc.
* imdaemon.php - if an IM plugin is enabled (like XMPP)
-* other daemons that you may have enabled
+* other daemons, like TwitterBridge ones, that you may have enabled
These daemons will automatically restart in most cases of failure
including memory leaks (if a memory_limit is set), but may still die
following files:
display.css: a CSS2 file for "default" styling for all browsers.
-ie6.css: a CSS2 file for override styling for fixing up Internet
- Explorer 6.
-ie7.css: a CSS2 file for override styling for fixing up Internet
- Explorer 7.
logo.png: a logo image for the site.
default-avatar-profile.png: a 96x96 pixel image to use as the avatar for
users who don't upload their own.
projects / quix0rs-gnu-social.git / blobdiff