INSTALL 17.1 KB
Newer Older
mmn's avatar
mmn committed
1 2 3 4 5 6 7 8
TABLE OF CONTENTS
=================
* Prerequisites
    - PHP modules
    - Better performance
* Installation
    - Getting it up and running
    - Fancy URLs
9 10 11
    - Themes
    - Private
* Extra features
mmn's avatar
mmn committed
12 13 14
    - Sphinx
    - SMS
    - Translation
15 16
    - Queues and daemons
* After installation
mmn's avatar
mmn committed
17
    - Backups
18
    - Upgrading
mmn's avatar
mmn committed
19

20 21 22
Prerequisites
=============

mmn's avatar
mmn committed
23 24 25
PHP modules
-----------

26 27 28
The following software packages are *required* for this software to
run correctly.

29
- PHP 5.5+      For newer versions, some functions that are used may be
30 31
                disabled by default, such as the pcntl_* family. See the
                section on 'Queues and daemons' for more information.
32
- MariaDB 5+    GNU Social uses, by default, a MariaDB server for data
33
                storage. Versions 5.x and 10.x have both reportedly
34
                worked well. It is also possible to run MySQL 5.5+.
35 36 37 38 39 40 41 42
- 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.

Your PHP installation must include the following PHP extensions for a
functional setup of GNU Social:

43
- openssl       (compiled in for Debian, enabled manually in Arch Linux)
44 45 46
- php5-curl     Fetching files by HTTP.
- php5-gd       Image manipulation (scaling).
- php5-gmp      For Salmon signatures (part of OStatus).
mmn's avatar
mmn committed
47
- php5-intl     Internationalization support (transliteration et al).
48 49
- php5-json     For WebFinger lookups and more.
- php5-mysqlnd  The native driver for PHP5 MariaDB connections. If you
50
                  use MySQL, 'php5-mysql' or 'php5-mysqli' may be enough.
51 52 53 54

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).
55 56 57

Better performance
------------------
58 59 60

For some functionality, you will also need the following extensions:

61 62 63
- 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
64 65 66 67 68 69 70
- 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.
71
- exif          For thumbnails to be properly oriented.
72

73 74
You may also experience better performance from your site if you configure
a PHP cache/accelerator. Most distributions come with "opcache" support.
75
Enable it in your php.ini where it is documented together with its settings.
76 77 78 79

Installation
============

mmn's avatar
mmn committed
80 81 82
Getting it up and running
-------------------------

83 84
Installing the basic GNU Social web component is relatively easy,
especially if you've previously installed PHP/MariaDB packages.
85 86 87 88

1. Unpack the tarball you downloaded on your Web server. Usually a
   command like this will work:

89
       tar zxf gnusocial-*.tar.gz
90

91
   ...which will make a gnusocial-x.y.z subdirectory in your current
92 93 94 95 96 97 98
   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:

99
       mv gnusocial-x.y.z /var/www/gnusocial
100

101 102 103 104 105 106 107 108 109 110
   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.

   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.
111

mmn's avatar
mmn committed
112 113 114
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.
115

116
       chmod a+w /var/www/gnusocial/
117

mmn's avatar
mmn committed
118
   On some systems, this will work as a more secure alternative:
119

120 121
       chgrp www-data /var/www/gnusocial/
       chmod g+w /var/www/gnusocial/
122 123 124

   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
125
   a new group like "gnusocial" and add the Web server's user to the group.
126

Danial Behzadi's avatar
Danial Behzadi committed
127
4. Create a database to hold your site data. Something like this
128
   should work (you will be prompted for your database password):
129

130
       mysqladmin -u "root" -p create social
131

132 133
   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,
134 135 136
   though.

   (If you don't have shell access to your server, you may need to use
137 138
   a tool like phpMyAdmin to create a database. Check your hosting
   service's documentation for how to create a new MariaDB database.)
139

Danial Behzadi's avatar
Danial Behzadi committed
140
5. Create a new database account that GNU Social will use to access the
141
   database. If you have shell access, this will probably work from the
142
   MariaDB shell:
143

144 145
       GRANT ALL on social.*
       TO 'social'@'localhost'
146
       IDENTIFIED BY 'agoodpassword';
147

148
   You should change the user identifier 'social' and 'agoodpassword'
149 150
   to your preferred new database username and password. You may want to
   test logging in to MariaDB as this new user.
151

Danial Behzadi's avatar
Danial Behzadi committed
152
6. In a browser, navigate to the GNU Social install script; something like:
153

154
       https://social.example.net/install.php
155 156 157 158 159

   Enter the database connection information and your site name. The
   install program will configure your site and install the initial,
   almost-empty database.

Danial Behzadi's avatar
Danial Behzadi committed
160
7. You should now be able to navigate to your social site's main directory
161 162
   and see the "Public Timeline", which will probably be empty. You can
   now register new user, post some notices, edit your profile, etc.
163 164 165 166

Fancy URLs
----------

167
By default, GNU Social will use URLs that include the main PHP program's
168 169
name in them. For example, a user's home profile might be found at either
of these URLS depending on the webserver's configuration and capabilities:
170

171 172
    https://social.example.net/index.php/fred
    https://social.example.net/index.php?p=fred
173

174 175
It's possible to configure the software to use fancy URLs so it looks like
this instead:
176

177
    https://social.example.net/fred
178 179 180 181

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
182
your server (like lighttpd or nginx).
183

184 185 186 187 188 189
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. 
    * For lighttpd, inspect the lighttpd.conf.example file and apply the
        appropriate changes in your virtualhost configuration for lighttpd.
chimo's avatar
chimo committed
190 191 192
    * For nginx, inspect the nginx.conf.sample file and apply the appropriate
        changes.
    * For other webservers, we gladly accept contributions of
193 194 195 196 197
        server configuration examples.

2. Assuming your webserver is properly configured and have its settings
    applied (remember to reload/restart it), you can add this to your
    GNU social's config.php file: 
198 199 200 201 202
       $config['site']['fancy'] = true;

You should now be able to navigate to a "fancy" URL on your server,
like:

203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242
    https://social.example.net/main/register

Themes
------

As of right now, your ability change the theme is limited to CSS
stylesheets and some image files; you can't change the HTML output,
like adding or removing menu items, without the help of a plugin.

You can choose a theme using the $config['site']['theme'] element in
the config.php file. See below for details.

You can add your own theme by making a sub-directory of the 'theme'
subdirectory with the name of your theme. Each theme can have the
following files:

display.css: a CSS2 file for "default" styling for all browsers.
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.
default-avatar-stream.png: Ditto, but 48x48. For streams of notices.
default-avatar-mini.png: Ditto ditto, but 24x24. For subscriptions
    listing on profile pages.

You may want to start by copying the files from the default theme to
your own directory.

Private
-------

A GNU social 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 GNU social 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 nodes are however an easy way to easily setup collaboration and
image sharing within a workgroup or a smaller community where federation
is not a desired feature. Also, it is possible to change this setting and
instantly gain full federation features.
243

244
Access to file attachments can also be restricted to logged-in users only:
245

246 247
1. Add a directory outside the web root where your file uploads will be
   stored. Use this command as an initial guideline to create it:
248

249 250 251 252 253 254 255 256 257 258
       mkdir /var/www/gnusocial-files

2. Make the file uploads directory writeable by the web server. An
   insecure way to do this is (to do it properly, read up on UNIX file
   permissions and configure your webserver accordingly):

       chmod a+x /var/www/gnusocial-files

3. Tell GNU social to use this directory for file uploads. Add a line
   like this to your config.php:
259

260
       $config['attachments']['dir'] = '/var/www/gnusocial-files';
261

262 263
Extra features
==============
264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327

Sphinx
------

To use a Sphinx server to search users and notices, you'll need to
enable the SphinxSearch plugin. Add to your config.php:

    addPlugin('SphinxSearch');
    $config['sphinx']['server'] = 'searchhost.local';

You also need to install, compile and enable the sphinx pecl extension for
php on the client side, which itself depends on the sphinx development files.

See plugins/SphinxSearch/README for more details and server setup.

SMS
---

StatusNet supports a cheap-and-dirty system for sending update messages
to mobile phones and for receiving updates from the mobile. Instead of
sending through the SMS network itself, which is costly and requires
buy-in from the wireless carriers, it simply piggybacks on the email
gateways that many carriers provide to their customers. So, SMS
configuration is essentially email configuration.

Each user sends to a made-up email address, which they keep a secret.
Incoming email that is "From" the user's SMS email address, and "To"
the users' secret email address on the site's domain, will be
converted to a notice and stored in the DB.

For this to work, there *must* be a domain or sub-domain for which all
(or most) incoming email can pass through the incoming mail filter.

1. Run the SQL script carrier.sql in your StatusNet database. This will
   usually work:

       mysql -u "statusnetuser" --password="statusnetpassword" statusnet < db/carrier.sql

   This will populate your database with a list of wireless carriers
   that support email SMS gateways.

2. Make sure the maildaemon.php file is executable:

       chmod +x scripts/maildaemon.php

   Note that "daemon" is kind of a misnomer here; the script is more
   of a filter than a daemon.

2. Edit /etc/aliases on your mail server and add the following line:

       *: /path/to/statusnet/scripts/maildaemon.php

3. Run whatever code you need to to update your aliases database. For
   many mail servers (Postfix, Exim, Sendmail), this should work:

       newaliases

   You may need to restart your mail server for the new database to
   take effect.

4. Set the following in your config.php file:

       $config['mail']['domain'] = 'yourdomain.example.net';

328 329
Translations
------------
330

331 332 333 334 335 336 337 338 339 340 341 342
For info on helping with translations, see the platform currently in use
for translations: https://www.transifex.com/projects/p/gnu-social/

Translations use the gettext system <http://www.gnu.org/software/gettext/>.
If you for some reason do not wish to sign up to the Transifex service,
you can review the files in the "locale/" sub-directory of GNU social.
Each plugin also has its own translation files.

To get your own site to use all the translated languages, and you are
tracking the git repo, you will need to install at least 'gettext' on
your system and then run:
    $ make translations
343 344 345 346 347

Queues and daemons
------------------

Some activities that StatusNet needs to do, like broadcast OStatus, SMS,
348 349 350 351 352 353 354 355 356 357 358
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
mmn's avatar
mmn committed
359
jobs during regular HTTP requests, like API or HTML pages calls.
360 361

Since queueing system is enabled by default, notices to be broadcasted
mmn's avatar
mmn committed
362
will be stored, by default, into DB (table queue_item).
363

mmn's avatar
mmn committed
364
Whenever it has time, OpportunisticQM will try to handle some of them.
365

mmn's avatar
mmn committed
366
This is a good solution whether you:
367 368

* have no access to command line (shared hosting)
mmn's avatar
mmn committed
369 370
* do not want to deal with long-running PHP processes
* run a low traffic GNU social instance
371

mmn's avatar
mmn committed
372
In other case, you really should consider enabling the queuedaemon for
mmn's avatar
mmn committed
373 374
performance reasons. Background daemons are necessary anyway if you wish
to use the Instant Messaging features such as communicating via XMPP.
375 376 377 378 379 380 381 382

### 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.
383 384 385 386

1. You'll need the "CLI" (command-line interface) version of PHP
   installed on whatever server you use.

387 388 389 390 391 392 393 394
   Modern PHP versions in some operating systems have disabled functions
   related to forking, which is required for daemons to operate. To make
   this work, make sure that your php-cli config (/etc/php5/cli/php.ini)
   does NOT have these functions listed under 'disable_functions':

       * pcntl_fork, pcntl_wait, pcntl_wifexited, pcntl_wexitstatus,
         pcntl_wifsignaled, pcntl_wtermsig

395 396 397 398
   Other recommended settings for optimal performance are:
       * mysqli.allow_persistent = On
       * mysqli.reconnect = On

399 400 401 402 403
2. If you're using a separate server for queues, install StatusNet
   somewhere on the server. You don't need to worry about the
   .htaccess file, but make sure that your config.php file is close
   to, or identical to, your Web server's version.

404 405
3. In your config.php files (on the server where you run the queue
    daemon), set the following variable:
406

407
       $config['queue']['daemon'] = true;
408

409 410
   You may also want to look at the 'Queues and Daemons' section in
   this file for more background processing options.
411 412 413 414 415 416 417

4. On the queues server, run the command scripts/startdaemons.sh.

This will run the queue handlers:

* queuedaemon.php - polls for queued items for inbox processing and
  pushing out to OStatus, SMS, XMPP, etc.
418
* imdaemon.php - if an IM plugin is enabled (like XMPP)
419
* other daemons, like TwitterBridge ones, that you may have enabled
420

421
These daemons will automatically restart in most cases of failure
422 423 424 425 426 427 428 429
including memory leaks (if a memory_limit is set), but may still die
or behave oddly if they lose connections to the XMPP or queue servers.

It may be a good idea to use a daemon-monitoring service, like 'monit',
to check their status and keep them running.

All the daemons write their process IDs (pids) to /var/run/ by
default. This can be useful for starting, stopping, and monitoring the
430 431 432
daemons. If you are running multiple sites on the same machine, it will
be necessary to avoid collisions of these PID files by setting a site-
specific directory in config.php:
433

434
       $config['daemon']['piddir'] = __DIR__ . '/../run/';
435

436 437 438
It is also possible to use a STOMP server instead of our kind of hacky
home-grown DB-based queue solution. This is strongly recommended for
best response time, especially when using XMPP.
439

440 441
After installation
==================
442 443 444 445

Backups
-------

446
There is no built-in system for doing backups in GNU social. You can make
447
backups of a working StatusNet system by backing up the database and
448
the Web directory. To backup the database use mysqldump <https://mariadb.com/kb/en/mariadb/mysqldump/>
449 450
and to backup the Web directory, try tar.

451 452
Upgrading
---------
453

454 455 456
Upgrading is strongly recommended to stay up to date with security fixes
and new features. For instructions on how to upgrade GNU social code,
please see the UPGRADE file.