INSTALL 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469
  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. - Sphinx
  10. - SMS
  11. - Queues and daemons
  12. - Themes
  13. - Translation
  14. - Backups
  15. - Private
  16. Prerequisites
  17. =============
  18. PHP modules
  19. -----------
  20. The following software packages are *required* for this software to
  21. run correctly.
  22. - PHP 5.4+ For newer versions, some functions that are used may be
  23. disabled by default, such as the pcntl_* family. See the
  24. section on 'Queues and daemons' for more information.
  25. - MariaDB 5+ GNU Social uses, by default, a MariaDB server for data
  26. storage. Versions 5.x and 10.x have both reportedly
  27. worked well. It is also possible to run MySQL 5.5+.
  28. - Web server Apache, lighttpd and nginx will all work. CGI mode is
  29. recommended and also some variant of 'suexec' (or a
  30. proper setup php-fpm pool)
  31. NOTE: mod_rewrite or its equivalent is extremely useful.
  32. Your PHP installation must include the following PHP extensions for a
  33. functional setup of GNU Social:
  34. - openssl (compiled in for Debian, enabled manually in Arch Linux)
  35. - php5-curl Fetching files by HTTP.
  36. - php5-gd Image manipulation (scaling).
  37. - php5-gmp For Salmon signatures (part of OStatus).
  38. - php5-json For WebFinger lookups and more.
  39. - php5-mysqlnd The native driver for PHP5 MariaDB connections. If you
  40. use MySQL, 'mysql' or 'mysqli' may work.
  41. The above package names are for Debian based systems. In the case of
  42. Arch Linux, PHP is compiled with support for most extensions but they
  43. require manual enabling in the relevant php.ini file (mostly php5-gmp).
  44. Better performance
  45. ------------------
  46. For some functionality, you will also need the following extensions:
  47. - opcache Improves performance a _lot_. Included in PHP, must be
  48. enabled manually in php.ini for most distributions. Find
  49. and set at least: opcache.enable=1
  50. - mailparse Efficient parsing of email requires this extension.
  51. Submission by email or SMS-over-email uses this.
  52. - sphinx A client for the sphinx server, an alternative to MySQL
  53. or Postgresql fulltext search. You will also need a
  54. Sphinx server to serve the search queries.
  55. - gettext For multiple languages. Default on many PHP installs;
  56. will be emulated if not present.
  57. - exif For thumbnails to be properly oriented.
  58. You may also experience better performance from your site if you configure
  59. a PHP cache/accelerator. Most distributions come with "opcache" support.
  60. Enable it in your php.ini, it is documented there together with its settings.
  61. Installation
  62. ============
  63. Getting it up and running
  64. -------------------------
  65. Installing the basic GNU Social web component is relatively easy,
  66. especially if you've previously installed PHP/MariaDB packages.
  67. 1. Unpack the tarball you downloaded on your Web server. Usually a
  68. command like this will work:
  69. tar zxf gnusocial-*.tar.gz
  70. ...which will make a gnusocial-x.y.z subdirectory in your current
  71. directory. (If you don't have shell access on your Web server, you
  72. may have to unpack the tarball on your local computer and FTP the
  73. files to the server.)
  74. 2. Move the tarball to a directory of your choosing in your Web root
  75. directory. Usually something like this will work:
  76. mv gnusocial-x.y.z /var/www/gnusocial
  77. This will often make your GNU Social instance available in the gnusocial
  78. path of your server, like "http://example.net/gnusocial". "social" or
  79. "blog" might also be good path names. If you know how to configure
  80. virtual hosts on your web server, you can try setting up
  81. "http://social.example.net/" or the like.
  82. If you have "rewrite" support on your webserver, and you should,
  83. then please enable this in order to make full use of your site. This
  84. will enable "Fancy URL" support, which you can read more about if you
  85. scroll down a bit in this document.
  86. 3. Make your target directory writeable by the Web server.
  87. chmod a+w /var/www/gnusocial/
  88. On some systems, this will probably work:
  89. chgrp www-data /var/www/gnusocial/
  90. chmod g+w /var/www/gnusocial/
  91. If your Web server runs as another user besides "www-data", try
  92. that user's default group instead. As a last resort, you can create
  93. a new group like "gnusocial" and add the Web server's user to the group.
  94. 4. You should also take this moment to make your avatar, background, and
  95. file subdirectories writeable by the Web server. An insecure way to do
  96. this is:
  97. chmod a+w /var/www/gnusocial/avatar
  98. chmod a+w /var/www/gnusocial/background
  99. chmod a+w /var/www/gnusocial/file
  100. You can also make the avatar, background, and file directories
  101. writeable by the Web server group, as noted above.
  102. 5. Create a database to hold your site data. Something like this
  103. should work:
  104. mysqladmin -u "root" --password="rootpassword" create gnusocial
  105. Note that GNU Social should have its own database; you should not share
  106. the database with another program. You can name it whatever you want,
  107. though.
  108. (If you don't have shell access to your server, you may need to use
  109. a tool like phpMyAdmin to create a database. Check your hosting
  110. service's documentation for how to create a new MariaDB database.)
  111. 6. Create a new database account that GNU Social will use to access the
  112. database. If you have shell access, this will probably work from the
  113. MariaDB shell:
  114. GRANT ALL on gnusocial.*
  115. TO 'gnusocial'@'localhost'
  116. IDENTIFIED BY 'agoodpassword';
  117. You should change the user identifier 'gnusocial' and 'agoodpassword'
  118. to your preferred new database username and password. You may want to
  119. test logging in to MariaDB as this new user.
  120. 7. In a browser, navigate to the GNU Social install script; something like:
  121. http://social.example.net/install.php
  122. Enter the database connection information and your site name. The
  123. install program will configure your site and install the initial,
  124. almost-empty database.
  125. 8. You should now be able to navigate to your social site's main directory
  126. and see the "Public Timeline", which will probably be empty. You can
  127. now register new user, post some notices, edit your profile, etc.
  128. Fancy URLs
  129. ----------
  130. By default, GNU Social will use URLs that include the main PHP program's
  131. name in them. For example, a user's home profile might be found at:
  132. http://example.net/gnusocial/index.php/gnusocial/fred
  133. On certain systems that don't support this kind of syntax, they'll
  134. look like this:
  135. http://example.net/gnusocial/index.php?p=gnusocial/fred
  136. It's possible to configure the software so it looks like this instead:
  137. http://example.net/gnusocial/fred
  138. These "fancy URLs" are more readable and memorable for users. To use
  139. fancy URLs, you must either have Apache 2.x with .htaccess enabled and
  140. mod_rewrite enabled, -OR- know how to configure "url redirection" in
  141. your server (like lighttpd or nginx).
  142. 1. Copy the htaccess.sample file to .htaccess in your StatusNet
  143. directory.
  144. 2. Change the "RewriteBase" in the new .htaccess file to be the URL path
  145. to your GNU Social installation on your server. Typically this will
  146. be the path to your GNU Social directory relative to your Web root.
  147. If you are installing it in the root directory, leave it as '/'.
  148. 3. Add, uncomment or change a line in your config.php file so it says:
  149. $config['site']['fancy'] = true;
  150. You should now be able to navigate to a "fancy" URL on your server,
  151. like:
  152. http://example.net/gnusocial/main/register
  153. If you changed your HTTP server configuration, you may need to restart
  154. the server first.
  155. If it doesn't work, double-check that AllowOverride for the GNU Social
  156. directory is 'All' in your Apache configuration file. This is usually
  157. /etc/httpd.conf, /etc/apache/httpd.conf, or (on Debian and Ubuntu)
  158. /etc/apache2/sites-available/default. See the Apache documentation for
  159. .htaccess files for more details:
  160. http://httpd.apache.org/docs/2.2/howto/htaccess.html
  161. Also, check that mod_rewrite is installed and enabled:
  162. http://httpd.apache.org/docs/2.2/mod/mod_rewrite.html
  163. Sphinx
  164. ------
  165. To use a Sphinx server to search users and notices, you'll need to
  166. enable the SphinxSearch plugin. Add to your config.php:
  167. addPlugin('SphinxSearch');
  168. $config['sphinx']['server'] = 'searchhost.local';
  169. You also need to install, compile and enable the sphinx pecl extension for
  170. php on the client side, which itself depends on the sphinx development files.
  171. See plugins/SphinxSearch/README for more details and server setup.
  172. SMS
  173. ---
  174. StatusNet supports a cheap-and-dirty system for sending update messages
  175. to mobile phones and for receiving updates from the mobile. Instead of
  176. sending through the SMS network itself, which is costly and requires
  177. buy-in from the wireless carriers, it simply piggybacks on the email
  178. gateways that many carriers provide to their customers. So, SMS
  179. configuration is essentially email configuration.
  180. Each user sends to a made-up email address, which they keep a secret.
  181. Incoming email that is "From" the user's SMS email address, and "To"
  182. the users' secret email address on the site's domain, will be
  183. converted to a notice and stored in the DB.
  184. For this to work, there *must* be a domain or sub-domain for which all
  185. (or most) incoming email can pass through the incoming mail filter.
  186. 1. Run the SQL script carrier.sql in your StatusNet database. This will
  187. usually work:
  188. mysql -u "statusnetuser" --password="statusnetpassword" statusnet < db/carrier.sql
  189. This will populate your database with a list of wireless carriers
  190. that support email SMS gateways.
  191. 2. Make sure the maildaemon.php file is executable:
  192. chmod +x scripts/maildaemon.php
  193. Note that "daemon" is kind of a misnomer here; the script is more
  194. of a filter than a daemon.
  195. 2. Edit /etc/aliases on your mail server and add the following line:
  196. *: /path/to/statusnet/scripts/maildaemon.php
  197. 3. Run whatever code you need to to update your aliases database. For
  198. many mail servers (Postfix, Exim, Sendmail), this should work:
  199. newaliases
  200. You may need to restart your mail server for the new database to
  201. take effect.
  202. 4. Set the following in your config.php file:
  203. $config['mail']['domain'] = 'yourdomain.example.net';
  204. Queues and daemons
  205. ------------------
  206. Some activities that StatusNet needs to do, like broadcast OStatus, SMS,
  207. XMPP messages and TwitterBridge operations, can be 'queued' and done by
  208. off-line bots instead.
  209. Two mechanisms are available to achieve offline operations:
  210. * New embedded OpportunisticQM plugin, which is enabled by default
  211. * Legacy queuedaemon script, which can be enabled via config file.
  212. ### OpportunisticQM plugin
  213. This plugin is enabled by default. It tries its best to do background
  214. job during regular HTTP requests, like API or HTML pages calls.
  215. Since queueing system is enabled by default, notices to be broadcasted
  216. will be stored, by default, into DB (table queue_item).
  217. Each time it can, OpportunisticQM will try to handle some of them.
  218. This is a good solution whether you:
  219. * have no access to command line (shared hosting)
  220. * do not want to deal with long-running PHP processes
  221. * run a low traffic GNU social instance
  222. In other case, you really should consider enabling the queuedaemon for
  223. performance reasons. Background daemons are necessary anyway if you wish
  224. to use the Instant Messaging features such as communicating via XMPP.
  225. ### queuedaemon
  226. If you want to use legacy queuedaemon, you must be able to run
  227. long-running offline processes, either on your main Web server or on
  228. another server you control. (Your other server will still need all the
  229. above prerequisites, with the exception of Apache.) Installing on a
  230. separate server is probably a good idea for high-volume sites.
  231. 1. You'll need the "CLI" (command-line interface) version of PHP
  232. installed on whatever server you use.
  233. Modern PHP versions in some operating systems have disabled functions
  234. related to forking, which is required for daemons to operate. To make
  235. this work, make sure that your php-cli config (/etc/php5/cli/php.ini)
  236. does NOT have these functions listed under 'disable_functions':
  237. * pcntl_fork, pcntl_wait, pcntl_wifexited, pcntl_wexitstatus,
  238. pcntl_wifsignaled, pcntl_wtermsig
  239. Other recommended settings for optimal performance are:
  240. * mysqli.allow_persistent = On
  241. * mysqli.reconnect = On
  242. 2. If you're using a separate server for queues, install StatusNet
  243. somewhere on the server. You don't need to worry about the
  244. .htaccess file, but make sure that your config.php file is close
  245. to, or identical to, your Web server's version.
  246. 3. In your config.php files (both the Web server and the queues
  247. server!), set the following variable:
  248. $config['queue']['enabled'] = true;
  249. $config['queue']['daemon'] = true;
  250. You may also want to look at the 'daemon' section of this file for
  251. more daemon options. Note that if you set the 'user' and/or 'group'
  252. options, you'll need to create that user and/or group by hand.
  253. They're not created automatically.
  254. 4. On the queues server, run the command scripts/startdaemons.sh.
  255. This will run the queue handlers:
  256. * queuedaemon.php - polls for queued items for inbox processing and
  257. pushing out to OStatus, SMS, XMPP, etc.
  258. * imdaemon.php - if an IM plugin is enabled (like XMPP)
  259. * other daemons, like TwitterBridge ones, that you may have enabled
  260. These daemons will automatically restart in most cases of failure
  261. including memory leaks (if a memory_limit is set), but may still die
  262. or behave oddly if they lose connections to the XMPP or queue servers.
  263. It may be a good idea to use a daemon-monitoring service, like 'monit',
  264. to check their status and keep them running.
  265. All the daemons write their process IDs (pids) to /var/run/ by
  266. default. This can be useful for starting, stopping, and monitoring the
  267. daemons. If you are running multiple sites on the same machine, it will
  268. be necessary to avoid collisions of these PID files by setting a site-
  269. specific directory in config.php:
  270. $config['daemon']['piddir'] = __DIR__ . '/../run/';
  271. It is also possible to use a STOMP server instead of our kind of hacky
  272. home-grown DB-based queue solution. This is strongly recommended for
  273. best response time, especially when using XMPP.
  274. Themes
  275. ------
  276. Older themes (version 0.9.x and below) no longer work with StatusNet
  277. 1.0.x, due to major changes in the site layout. We ship with three new
  278. themes for this version, 'neo', 'neo-blue' and 'neo-light'.
  279. As of right now, your ability to change the theme is site-wide; users
  280. can't choose their own theme. Additionally, the only thing you can
  281. change in the theme is CSS stylesheets and some image files; you can't
  282. change the HTML output, like adding or removing menu items.
  283. You can choose a theme using the $config['site']['theme'] element in
  284. the config.php file. See below for details.
  285. You can add your own theme by making a sub-directory of the 'theme'
  286. subdirectory with the name of your theme. Each theme can have the
  287. following files:
  288. display.css: a CSS2 file for "default" styling for all browsers.
  289. logo.png: a logo image for the site.
  290. default-avatar-profile.png: a 96x96 pixel image to use as the avatar for
  291. users who don't upload their own.
  292. default-avatar-stream.png: Ditto, but 48x48. For streams of notices.
  293. default-avatar-mini.png: Ditto ditto, but 24x24. For subscriptions
  294. listing on profile pages.
  295. You may want to start by copying the files from the default theme to
  296. your own directory.
  297. Translation
  298. -----------
  299. Translations in StatusNet use the gettext system <http://www.gnu.org/software/gettext/>.
  300. Theoretically, you can add your own sub-directory to the locale/
  301. subdirectory to add a new language to your system. You'll need to
  302. compile the ".po" files into ".mo" files, however.
  303. Contributions of translation information to StatusNet are very easy:
  304. you can use the Web interface at translatewiki.net to add one
  305. or a few or lots of new translations -- or even new languages. You can
  306. also download more up-to-date .po files there, if you so desire.
  307. For info on helping with translations, see http://status.net/wiki/Translations
  308. Backups
  309. -------
  310. There is no built-in system for doing backups in StatusNet. You can make
  311. backups of a working StatusNet system by backing up the database and
  312. the Web directory. To backup the database use mysqldump <http://ur1.ca/7xo>
  313. and to backup the Web directory, try tar.
  314. Private
  315. -------
  316. The administrator can set the "private" flag for a site so that it's
  317. not visible to non-logged-in users. (This is the default for new installs of version 1.0!)
  318. This might be useful for workgroups who want to share a social
  319. networking site for project management, but host it on a public
  320. server.
  321. Total privacy is attempted but not guaranteed or ensured. Private sites
  322. currently don't work well with OStatus federation.
  323. Access to file attachments can also be restricted to logged-in users only.
  324. 1. Add a directory outside the web root where your file uploads will be
  325. stored. Usually a command like this will work:
  326. mkdir /var/www/statusnet-files
  327. 2. Make the file uploads directory writeable by the web server. An
  328. insecure way to do this is:
  329. chmod a+x /var/www/statusnet-files
  330. 3. Tell StatusNet to use this directory for file uploads. Add a line
  331. like this to your config.php:
  332. $config['attachments']['dir'] = '/var/www/statusnet-files';