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