]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - INSTALL
Merge branch 'master' of https://git.gnu.io/gnu/gnu-social into social-master
[quix0rs-gnu-social.git] / INSTALL
1 TABLE OF CONTENTS
2 =================
3 * Prerequisites
4     - PHP modules
5     - Better performance
6 * Installation
7     - Getting it up and running
8     - Fancy URLs
9     - Themes
10     - Private
11 * Extra features
12     - Sphinx
13     - SMS
14     - Translation
15     - Queues and daemons
16 * After installation
17     - Backups
18     - Upgrading
19
20 Prerequisites
21 =============
22
23 PHP modules
24 -----------
25
26 The following software packages are *required* for this software to
27 run correctly.
28
29 - PHP 5.5+      For newer versions, some functions that are used may be
30                 disabled by default, such as the pcntl_* family. See the
31                 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 - Web server    Apache, lighttpd and nginx will all work. CGI mode is
36                 recommended and also some variant of 'suexec' (or a
37                 proper setup php-fpm pool)
38                 NOTE: mod_rewrite or its equivalent is extremely useful.
39
40 Your PHP installation must include the following PHP extensions for a
41 functional setup of GNU Social:
42
43 - openssl       (compiled in for Debian, enabled manually in Arch Linux)
44 - php5-curl     Fetching files by HTTP.
45 - php5-gd       Image manipulation (scaling).
46 - php5-gmp      For Salmon signatures (part of OStatus).
47 - php5-intl     Internationalization support (transliteration et al).
48 - php5-json     For WebFinger lookups and more.
49 - php5-mysqlnd  The native driver for PHP5 MariaDB connections. If you
50                   use MySQL, 'php5-mysql' or 'php5-mysqli' may be enough.
51
52 The above package names are for Debian based systems. In the case of
53 Arch Linux, PHP is compiled with support for most extensions but they
54 require manual enabling in the relevant php.ini file (mostly php5-gmp).
55
56 Better performance
57 ------------------
58
59 For some functionality, you will also need the following extensions:
60
61 - opcache       Improves performance a _lot_. Included in PHP, must be
62                 enabled manually in php.ini for most distributions. Find
63                 and set at least:  opcache.enable=1
64 - mailparse     Efficient parsing of email requires this extension.
65                 Submission by email or SMS-over-email uses this.
66 - sphinx        A client for the sphinx server, an alternative to MySQL
67                 or Postgresql fulltext search. You will also need a
68                 Sphinx server to serve the search queries.
69 - gettext       For multiple languages. Default on many PHP installs;
70                 will be emulated if not present.
71 - exif          For thumbnails to be properly oriented.
72
73 You may also experience better performance from your site if you configure
74 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 Installation
78 ============
79
80 Getting it up and running
81 -------------------------
82
83 Installing the basic GNU Social web component is relatively easy,
84 especially if you've previously installed PHP/MariaDB packages.
85
86 1. Unpack the tarball you downloaded on your Web server. Usually a
87    command like this will work:
88
89        tar zxf gnusocial-*.tar.gz
90
91    ...which will make a gnusocial-x.y.z subdirectory in your current
92    directory. (If you don't have shell access on your Web server, you
93    may have to unpack the tarball on your local computer and FTP the
94    files to the server.)
95
96 2. Move the tarball to a directory of your choosing in your Web root
97    directory. Usually something like this will work:
98
99        mv gnusocial-x.y.z /var/www/gnusocial
100
101    This will often make your GNU Social instance available in the gnusocial
102    path of your server, like "http://example.net/gnusocial". "social" or
103    "blog" might also be good path names. If you know how to configure 
104    virtual hosts on your web server, you can try setting up
105    "http://social.example.net/" or the like.
106
107    If you have "rewrite" support on your webserver, and you should,
108    then please enable this in order to make full use of your site. This
109    will enable "Fancy URL" support, which you can read more about if you
110    scroll down a bit in this document.
111
112 3. Make your target directory writeable by the Web server.
113
114        chmod a+w /var/www/gnusocial/
115
116    On some systems, this will probably work:
117
118        chgrp www-data /var/www/gnusocial/
119        chmod g+w /var/www/gnusocial/
120
121    If your Web server runs as another user besides "www-data", try
122    that user's default group instead. As a last resort, you can create
123    a new group like "gnusocial" and add the Web server's user to the group.
124
125 4. You should also take this moment to make your avatar, background, and
126    file subdirectories writeable by the Web server. An insecure way to do
127    this is:
128
129        chmod a+w /var/www/gnusocial/avatar
130        chmod a+w /var/www/gnusocial/background
131        chmod a+w /var/www/gnusocial/file
132
133    You can also make the avatar, background, and file directories
134    writeable by the Web server group, as noted above.
135
136 5. Create a database to hold your site data. Something like this
137    should work (you will be prompted for your database password):
138
139        mysqladmin -u "root" -p create social
140
141    Note that GNU Social should have its own database; you should not share
142    the database with another program. You can name it whatever you want,
143    though.
144
145    (If you don't have shell access to your server, you may need to use
146    a tool like phpMyAdmin to create a database. Check your hosting
147    service's documentation for how to create a new MariaDB database.)
148
149 6. Create a new database account that GNU Social will use to access the
150    database. If you have shell access, this will probably work from the
151    MariaDB shell:
152
153        GRANT ALL on social.*
154        TO 'social'@'localhost'
155        IDENTIFIED BY 'agoodpassword';
156
157    You should change the user identifier 'social' and 'agoodpassword'
158    to your preferred new database username and password. You may want to
159    test logging in to MariaDB as this new user.
160
161 7. In a browser, navigate to the GNU Social install script; something like:
162
163        https://social.example.net/install.php
164
165    Enter the database connection information and your site name. The
166    install program will configure your site and install the initial,
167    almost-empty database.
168
169 8. You should now be able to navigate to your social site's main directory
170    and see the "Public Timeline", which will probably be empty. You can
171    now register new user, post some notices, edit your profile, etc.
172
173 Fancy URLs
174 ----------
175
176 By default, GNU Social will use URLs that include the main PHP program's
177 name in them. For example, a user's home profile might be found at either
178 of these URLS depending on the webserver's configuration and capabilities:
179
180     https://social.example.net/index.php/fred
181     https://social.example.net/index.php?p=fred
182
183 It's possible to configure the software to use fancy URLs so it looks like
184 this instead:
185
186     https://social.example.net/fred
187
188 These "fancy URLs" are more readable and memorable for users. To use
189 fancy URLs, you must either have Apache 2.x with .htaccess enabled and
190 mod_rewrite enabled, -OR- know how to configure "url redirection" in
191 your server (like lighttpd or nginx).
192
193 1. See the instructions for each respective webserver software:
194     * For Apache, inspect the "htaccess.sample" file and save it as
195         ".htaccess" after making any necessary modifications. Our sample
196         file is well commented. 
197     * For lighttpd, inspect the lighttpd.conf.example file and apply the
198         appropriate changes in your virtualhost configuration for lighttpd.
199     * For nginx and other webservers, we gladly accept contributions of
200         server configuration examples.
201
202 2. Assuming your webserver is properly configured and have its settings
203     applied (remember to reload/restart it), you can add this to your
204     GNU social's config.php file: 
205        $config['site']['fancy'] = true;
206
207 You should now be able to navigate to a "fancy" URL on your server,
208 like:
209
210     https://social.example.net/main/register
211
212 Themes
213 ------
214
215 As of right now, your ability change the theme is limited to CSS
216 stylesheets and some image files; you can't change the HTML output,
217 like adding or removing menu items, without the help of a plugin.
218
219 You can choose a theme using the $config['site']['theme'] element in
220 the config.php file. See below for details.
221
222 You can add your own theme by making a sub-directory of the 'theme'
223 subdirectory with the name of your theme. Each theme can have the
224 following files:
225
226 display.css: a CSS2 file for "default" styling for all browsers.
227 logo.png: a logo image for the site.
228 default-avatar-profile.png: a 96x96 pixel image to use as the avatar for
229     users who don't upload their own.
230 default-avatar-stream.png: Ditto, but 48x48. For streams of notices.
231 default-avatar-mini.png: Ditto ditto, but 24x24. For subscriptions
232     listing on profile pages.
233
234 You may want to start by copying the files from the default theme to
235 your own directory.
236
237 Private
238 -------
239
240 A GNU social node can be configured as "private", which means it will not
241 federate with other nodes in the network. It is not a recommended method
242 of using GNU social and we cannot at the current state of development
243 guarantee that there are no leaks (what a public network sees as features,
244 private sites will likely see as bugs). 
245
246 Private nodes are however an easy way to easily setup collaboration and
247 image sharing within a workgroup or a smaller community where federation
248 is not a desired feature. Also, it is possible to change this setting and
249 instantly gain full federation features.
250
251 Access to file attachments can also be restricted to logged-in users only:
252
253 1. Add a directory outside the web root where your file uploads will be
254    stored. Use this command as an initial guideline to create it:
255
256        mkdir /var/www/gnusocial-files
257
258 2. Make the file uploads directory writeable by the web server. An
259    insecure way to do this is (to do it properly, read up on UNIX file
260    permissions and configure your webserver accordingly):
261
262        chmod a+x /var/www/gnusocial-files
263
264 3. Tell GNU social to use this directory for file uploads. Add a line
265    like this to your config.php:
266
267        $config['attachments']['dir'] = '/var/www/gnusocial-files';
268
269 Extra features
270 ==============
271
272 Sphinx
273 ------
274
275 To use a Sphinx server to search users and notices, you'll need to
276 enable the SphinxSearch plugin. Add to your config.php:
277
278     addPlugin('SphinxSearch');
279     $config['sphinx']['server'] = 'searchhost.local';
280
281 You also need to install, compile and enable the sphinx pecl extension for
282 php on the client side, which itself depends on the sphinx development files.
283
284 See plugins/SphinxSearch/README for more details and server setup.
285
286 SMS
287 ---
288
289 StatusNet supports a cheap-and-dirty system for sending update messages
290 to mobile phones and for receiving updates from the mobile. Instead of
291 sending through the SMS network itself, which is costly and requires
292 buy-in from the wireless carriers, it simply piggybacks on the email
293 gateways that many carriers provide to their customers. So, SMS
294 configuration is essentially email configuration.
295
296 Each user sends to a made-up email address, which they keep a secret.
297 Incoming email that is "From" the user's SMS email address, and "To"
298 the users' secret email address on the site's domain, will be
299 converted to a notice and stored in the DB.
300
301 For this to work, there *must* be a domain or sub-domain for which all
302 (or most) incoming email can pass through the incoming mail filter.
303
304 1. Run the SQL script carrier.sql in your StatusNet database. This will
305    usually work:
306
307        mysql -u "statusnetuser" --password="statusnetpassword" statusnet < db/carrier.sql
308
309    This will populate your database with a list of wireless carriers
310    that support email SMS gateways.
311
312 2. Make sure the maildaemon.php file is executable:
313
314        chmod +x scripts/maildaemon.php
315
316    Note that "daemon" is kind of a misnomer here; the script is more
317    of a filter than a daemon.
318
319 2. Edit /etc/aliases on your mail server and add the following line:
320
321        *: /path/to/statusnet/scripts/maildaemon.php
322
323 3. Run whatever code you need to to update your aliases database. For
324    many mail servers (Postfix, Exim, Sendmail), this should work:
325
326        newaliases
327
328    You may need to restart your mail server for the new database to
329    take effect.
330
331 4. Set the following in your config.php file:
332
333        $config['mail']['domain'] = 'yourdomain.example.net';
334
335 Translations
336 ------------
337
338 For info on helping with translations, see the platform currently in use
339 for translations: https://www.transifex.com/projects/p/gnu-social/
340
341 Translations use the gettext system <http://www.gnu.org/software/gettext/>.
342 If you for some reason do not wish to sign up to the Transifex service,
343 you can review the files in the "locale/" sub-directory of GNU social.
344 Each plugin also has its own translation files.
345
346 To get your own site to use all the translated languages, and you are
347 tracking the git repo, you will need to install at least 'gettext' on
348 your system and then run:
349     $ make translations
350
351 Queues and daemons
352 ------------------
353
354 Some activities that StatusNet needs to do, like broadcast OStatus, SMS,
355 XMPP messages and TwitterBridge operations, can be 'queued' and done by
356 off-line bots instead.
357
358 Two mechanisms are available to achieve offline operations:
359
360 * New embedded OpportunisticQM plugin, which is enabled by default
361 * Legacy queuedaemon script, which can be enabled via config file.
362
363 ### OpportunisticQM plugin
364
365 This plugin is enabled by default. It tries its best to do background
366 job during regular HTTP requests, like API or HTML pages calls.
367
368 Since queueing system is enabled by default, notices to be broadcasted
369 will be stored, by default, into DB (table queue_item).
370
371 Each time it can, OpportunisticQM will try to handle some of them.
372
373 This is a good solution whether you:
374
375 * have no access to command line (shared hosting)
376 * do not want to deal with long-running PHP processes
377 * run a low traffic GNU social instance
378
379 In other case, you really should consider enabling the queuedaemon for
380 performance reasons. Background daemons are necessary anyway if you wish
381 to use the Instant Messaging features such as communicating via XMPP.
382
383 ### queuedaemon
384
385 If you want to use legacy queuedaemon, you must be able to run
386 long-running offline processes, either on your main Web server or on
387 another server you control. (Your other server will still need all the
388 above prerequisites, with the exception of Apache.) Installing on a
389 separate server is probably a good idea for high-volume sites.
390
391 1. You'll need the "CLI" (command-line interface) version of PHP
392    installed on whatever server you use.
393
394    Modern PHP versions in some operating systems have disabled functions
395    related to forking, which is required for daemons to operate. To make
396    this work, make sure that your php-cli config (/etc/php5/cli/php.ini)
397    does NOT have these functions listed under 'disable_functions':
398
399        * pcntl_fork, pcntl_wait, pcntl_wifexited, pcntl_wexitstatus,
400          pcntl_wifsignaled, pcntl_wtermsig
401
402    Other recommended settings for optimal performance are:
403        * mysqli.allow_persistent = On
404        * mysqli.reconnect = On
405
406 2. If you're using a separate server for queues, install StatusNet
407    somewhere on the server. You don't need to worry about the
408    .htaccess file, but make sure that your config.php file is close
409    to, or identical to, your Web server's version.
410
411 3. In your config.php files (on the server where you run the queue
412     daemon), set the following variable:
413
414        $config['queue']['daemon'] = true;
415
416    You may also want to look at the 'Queues and Daemons' section in
417    this file for more background processing options.
418
419 4. On the queues server, run the command scripts/startdaemons.sh.
420
421 This will run the queue handlers:
422
423 * queuedaemon.php - polls for queued items for inbox processing and
424   pushing out to OStatus, SMS, XMPP, etc.
425 * imdaemon.php - if an IM plugin is enabled (like XMPP)
426 * other daemons, like TwitterBridge ones, that you may have enabled
427
428 These daemons will automatically restart in most cases of failure
429 including memory leaks (if a memory_limit is set), but may still die
430 or behave oddly if they lose connections to the XMPP or queue servers.
431
432 It may be a good idea to use a daemon-monitoring service, like 'monit',
433 to check their status and keep them running.
434
435 All the daemons write their process IDs (pids) to /var/run/ by
436 default. This can be useful for starting, stopping, and monitoring the
437 daemons. If you are running multiple sites on the same machine, it will
438 be necessary to avoid collisions of these PID files by setting a site-
439 specific directory in config.php:
440
441        $config['daemon']['piddir'] = __DIR__ . '/../run/';
442
443 It is also possible to use a STOMP server instead of our kind of hacky
444 home-grown DB-based queue solution. This is strongly recommended for
445 best response time, especially when using XMPP.
446
447 After installation
448 ==================
449
450 Backups
451 -------
452
453 There is no built-in system for doing backups in GNU social. You can make
454 backups of a working StatusNet system by backing up the database and
455 the Web directory. To backup the database use mysqldump <https://mariadb.com/kb/en/mariadb/mysqldump/>
456 and to backup the Web directory, try tar.
457
458 Upgrading
459 ---------
460
461 Upgrading is strongly recommended to stay up to date with security fixes
462 and new features. For instructions on how to upgrade GNU social code,
463 please see the UPGRADE file.