]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - INSTALL
Merge branch 'xmpphp-fix' into '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, please note
113    however that 'a+w' will give _all_ users write access and securing the
114    webserver is not within the scope of this document.
115
116        chmod a+w /var/www/gnusocial/
117
118    On some systems, this will work as a more secure alternative:
119
120        chgrp www-data /var/www/gnusocial/
121        chmod g+w /var/www/gnusocial/
122
123    If your Web server runs as another user besides "www-data", try
124    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
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    Note that GNU Social should have its own database; you should not share
133    the database with another program. You can name it whatever you want,
134    though.
135
136    (If you don't have shell access to your server, you may need to use
137    a tool like phpMyAdmin to create a database. Check your hosting
138    service's documentation for how to create a new MariaDB database.)
139
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        GRANT ALL on social.*
145        TO 'social'@'localhost'
146        IDENTIFIED BY 'agoodpassword';
147
148    You should change the user identifier 'social' and 'agoodpassword'
149    to your preferred new database username and password. You may want to
150    test logging in to MariaDB as this new user.
151
152 6. In a browser, navigate to the GNU Social install script; something like:
153
154        https://social.example.net/install.php
155
156    Enter the database connection information and your site name. The
157    install program will configure your site and install the initial,
158    almost-empty database.
159
160 7. You should now be able to navigate to your social site's main directory
161    and see the "Public Timeline", which will probably be empty. You can
162    now register new user, post some notices, edit your profile, etc.
163
164 Fancy URLs
165 ----------
166
167 By default, GNU Social will use URLs that include the main PHP program's
168 name in them. For example, a user's home profile might be found at either
169 of these URLS depending on the webserver's configuration and capabilities:
170
171     https://social.example.net/index.php/fred
172     https://social.example.net/index.php?p=fred
173
174 It's possible to configure the software to use fancy URLs so it looks like
175 this instead:
176
177     https://social.example.net/fred
178
179 These "fancy URLs" are more readable and memorable for users. To use
180 fancy URLs, you must either have Apache 2.x with .htaccess enabled and
181 mod_rewrite enabled, -OR- know how to configure "url redirection" in
182 your server (like lighttpd or nginx).
183
184 1. See the instructions for each respective webserver software:
185     * For Apache, inspect the "htaccess.sample" file and save it as
186         ".htaccess" after making any necessary modifications. Our sample
187         file is well commented. 
188     * For lighttpd, inspect the lighttpd.conf.example file and apply the
189         appropriate changes in your virtualhost configuration for lighttpd.
190     * For nginx, inspect the nginx.conf.sample file and apply the appropriate
191         changes.
192     * For other webservers, we gladly accept contributions of
193         server configuration examples.
194
195 2. Assuming your webserver is properly configured and have its settings
196     applied (remember to reload/restart it), you can add this to your
197     GNU social's config.php file: 
198        $config['site']['fancy'] = true;
199
200 You should now be able to navigate to a "fancy" URL on your server,
201 like:
202
203     https://social.example.net/main/register
204
205 Themes
206 ------
207
208 As of right now, your ability change the theme is limited to CSS
209 stylesheets and some image files; you can't change the HTML output,
210 like adding or removing menu items, without the help of a plugin.
211
212 You can choose a theme using the $config['site']['theme'] element in
213 the config.php file. See below for details.
214
215 You can add your own theme by making a sub-directory of the 'theme'
216 subdirectory with the name of your theme. Each theme can have the
217 following files:
218
219 display.css: a CSS2 file for "default" styling for all browsers.
220 logo.png: a logo image for the site.
221 default-avatar-profile.png: a 96x96 pixel image to use as the avatar for
222     users who don't upload their own.
223 default-avatar-stream.png: Ditto, but 48x48. For streams of notices.
224 default-avatar-mini.png: Ditto ditto, but 24x24. For subscriptions
225     listing on profile pages.
226
227 You may want to start by copying the files from the default theme to
228 your own directory.
229
230 Private
231 -------
232
233 A GNU social node can be configured as "private", which means it will not
234 federate with other nodes in the network. It is not a recommended method
235 of using GNU social and we cannot at the current state of development
236 guarantee that there are no leaks (what a public network sees as features,
237 private sites will likely see as bugs). 
238
239 Private nodes are however an easy way to easily setup collaboration and
240 image sharing within a workgroup or a smaller community where federation
241 is not a desired feature. Also, it is possible to change this setting and
242 instantly gain full federation features.
243
244 Access to file attachments can also be restricted to logged-in users only:
245
246 1. Add a directory outside the web root where your file uploads will be
247    stored. Use this command as an initial guideline to create it:
248
249        mkdir /var/www/gnusocial-files
250
251 2. Make the file uploads directory writeable by the web server. An
252    insecure way to do this is (to do it properly, read up on UNIX file
253    permissions and configure your webserver accordingly):
254
255        chmod a+x /var/www/gnusocial-files
256
257 3. Tell GNU social to use this directory for file uploads. Add a line
258    like this to your config.php:
259
260        $config['attachments']['dir'] = '/var/www/gnusocial-files';
261
262 Extra features
263 ==============
264
265 Sphinx
266 ------
267
268 To use a Sphinx server to search users and notices, you'll need to
269 enable the SphinxSearch plugin. Add to your config.php:
270
271     addPlugin('SphinxSearch');
272     $config['sphinx']['server'] = 'searchhost.local';
273
274 You also need to install, compile and enable the sphinx pecl extension for
275 php on the client side, which itself depends on the sphinx development files.
276
277 See plugins/SphinxSearch/README for more details and server setup.
278
279 SMS
280 ---
281
282 StatusNet supports a cheap-and-dirty system for sending update messages
283 to mobile phones and for receiving updates from the mobile. Instead of
284 sending through the SMS network itself, which is costly and requires
285 buy-in from the wireless carriers, it simply piggybacks on the email
286 gateways that many carriers provide to their customers. So, SMS
287 configuration is essentially email configuration.
288
289 Each user sends to a made-up email address, which they keep a secret.
290 Incoming email that is "From" the user's SMS email address, and "To"
291 the users' secret email address on the site's domain, will be
292 converted to a notice and stored in the DB.
293
294 For this to work, there *must* be a domain or sub-domain for which all
295 (or most) incoming email can pass through the incoming mail filter.
296
297 1. Run the SQL script carrier.sql in your StatusNet database. This will
298    usually work:
299
300        mysql -u "statusnetuser" --password="statusnetpassword" statusnet < db/carrier.sql
301
302    This will populate your database with a list of wireless carriers
303    that support email SMS gateways.
304
305 2. Make sure the maildaemon.php file is executable:
306
307        chmod +x scripts/maildaemon.php
308
309    Note that "daemon" is kind of a misnomer here; the script is more
310    of a filter than a daemon.
311
312 2. Edit /etc/aliases on your mail server and add the following line:
313
314        *: /path/to/statusnet/scripts/maildaemon.php
315
316 3. Run whatever code you need to to update your aliases database. For
317    many mail servers (Postfix, Exim, Sendmail), this should work:
318
319        newaliases
320
321    You may need to restart your mail server for the new database to
322    take effect.
323
324 4. Set the following in your config.php file:
325
326        $config['mail']['domain'] = 'yourdomain.example.net';
327
328 Translations
329 ------------
330
331 For info on helping with translations, see the platform currently in use
332 for translations: https://www.transifex.com/projects/p/gnu-social/
333
334 Translations use the gettext system <http://www.gnu.org/software/gettext/>.
335 If you for some reason do not wish to sign up to the Transifex service,
336 you can review the files in the "locale/" sub-directory of GNU social.
337 Each plugin also has its own translation files.
338
339 To get your own site to use all the translated languages, and you are
340 tracking the git repo, you will need to install at least 'gettext' on
341 your system and then run:
342     $ make translations
343
344 Queues and daemons
345 ------------------
346
347 Some activities that StatusNet needs to do, like broadcast OStatus, SMS,
348 XMPP messages and TwitterBridge operations, can be 'queued' and done by
349 off-line bots instead.
350
351 Two mechanisms are available to achieve offline operations:
352
353 * New embedded OpportunisticQM plugin, which is enabled by default
354 * Legacy queuedaemon script, which can be enabled via config file.
355
356 ### OpportunisticQM plugin
357
358 This plugin is enabled by default. It tries its best to do background
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
362 will be stored, by default, into DB (table queue_item).
363
364 Whenever it has time, OpportunisticQM will try to handle some of them.
365
366 This is a good solution whether you:
367
368 * have no access to command line (shared hosting)
369 * do not want to deal with long-running PHP processes
370 * run a low traffic GNU social instance
371
372 In other case, you really should consider enabling the queuedaemon for
373 performance reasons. Background daemons are necessary anyway if you wish
374 to use the Instant Messaging features such as communicating via XMPP.
375
376 ### queuedaemon
377
378 If you want to use legacy queuedaemon, you must be able to run
379 long-running offline processes, either on your main Web server or on
380 another server you control. (Your other server will still need all the
381 above prerequisites, with the exception of Apache.) Installing on a
382 separate server is probably a good idea for high-volume sites.
383
384 1. You'll need the "CLI" (command-line interface) version of PHP
385    installed on whatever server you use.
386
387    Modern PHP versions in some operating systems have disabled functions
388    related to forking, which is required for daemons to operate. To make
389    this work, make sure that your php-cli config (/etc/php5/cli/php.ini)
390    does NOT have these functions listed under 'disable_functions':
391
392        * pcntl_fork, pcntl_wait, pcntl_wifexited, pcntl_wexitstatus,
393          pcntl_wifsignaled, pcntl_wtermsig
394
395    Other recommended settings for optimal performance are:
396        * mysqli.allow_persistent = On
397        * mysqli.reconnect = On
398
399 2. If you're using a separate server for queues, install StatusNet
400    somewhere on the server. You don't need to worry about the
401    .htaccess file, but make sure that your config.php file is close
402    to, or identical to, your Web server's version.
403
404 3. In your config.php files (on the server where you run the queue
405     daemon), set the following variable:
406
407        $config['queue']['daemon'] = true;
408
409    You may also want to look at the 'Queues and Daemons' section in
410    this file for more background processing options.
411
412 4. On the queues server, run the command scripts/startdaemons.sh.
413
414 This will run the queue handlers:
415
416 * queuedaemon.php - polls for queued items for inbox processing and
417   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 including memory leaks (if a memory_limit is set), but may still die
423 or behave oddly if they lose connections to the XMPP or queue servers.
424
425 It may be a good idea to use a daemon-monitoring service, like 'monit',
426 to check their status and keep them running.
427
428 All the daemons write their process IDs (pids) to /var/run/ by
429 default. This can be useful for starting, stopping, and monitoring the
430 daemons. If you are running multiple sites on the same machine, it will
431 be necessary to avoid collisions of these PID files by setting a site-
432 specific directory in config.php:
433
434        $config['daemon']['piddir'] = __DIR__ . '/../run/';
435
436 It is also possible to use a STOMP server instead of our kind of hacky
437 home-grown DB-based queue solution. This is strongly recommended for
438 best response time, especially when using XMPP.
439
440 After installation
441 ==================
442
443 Backups
444 -------
445
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 and to backup the Web directory, try tar.
450
451 Upgrading
452 ---------
453
454 Upgrading is strongly recommended to stay up to date with security fixes
455 and new features. For instructions on how to upgrade GNU social code,
456 please see the UPGRADE file.