social-doc/html/admin/installing.html

{HEADING:SECTION:prerequisites:Prerequisites}

{HEADING:SUBSECTION:choosing_branch:Selecting a branch}

<p>GNU social has three different branches of development offering a range of choices between stability and the latest features. They are roughly equivalent to Debian's <i>stable</i>, <i>testing</i> and <i>unstable</i>.</p>

<dl>
	<dt>1.2.x</dt>
	<dd>This is the current stable release. The code has been tested for a while.</dd>
	
	<dt>master</dt>
	<dd>This receives more frequent updates and is usually working well.</dd>
	
	<dt>nightly</dt>
	<dd>This gets updated the most but is not always working.</dd>
</dl>

<p>When you download the source code in {LINK:up_and_running} you will need to know which branch you want to install. You should have no problem moving to a more unstable branch but going backwards may not work.</p>

<p>If you want to use <a href="https://git.gnu.io/h2p/Qvitter">Qvitter</a>&mdash;that's the plugin that makes GNU social look like Twitter&mdash;be aware that it is tested against GNU social <i>nightly</i>. If you are using a different branch and having problems with that plugin try upgrading to nightly.</p>

{HEADING:SUBSECTION:choosing_web_config:Web server configuration}

<p>If you are planning to host your GNU social server with HTTPS then you should make sure your encryption is in place before using GNU social. You may have problems if you start with HTTP and move to HTTPS.</p>

<p>You really should be using HTTPS nowadays. There is no good reason not to. The Let's Encrypt project makes it free and easy to <a href="https://letsencrypt.org/howitworks/">set up a trusted certificate on your web server</a>.<p>

<p>If you want to use Qvitter be aware that it only supports installations that are installed directly on the domain. That is, the URL to access GNU social needs to be <tt>https://www.some.domain/</tt> and not <tt>https://www.some.domain/gnusocial/</tt>. It only works if you have so-called {LINK:fancy_urls} enabled. If you're using apache that means you need mod_rewrite and the ability to use <tt>.htaccess</tt> files.</p>

{HEADING:SUBSECTION:php_modules:PHP modules}

<p>The following software packages are <em>required</em> for this software to run correctly.</p>

<dl>
	<dt>PHP 5.5+</dt>
	<dd>For newer versions, some functions that are used may be disabled by default, such as the pcntl_* family. See the section on 'Queues and daemons' for more information.</dd>
	
	<dt>MariaDB 5+</dt>
	<dd>GNU Social uses, by default, a MariaDB server for data storage. Versions 5.x and 10.x have both reportedly worked well. It is also possible to run MySQL 5.5+.</dd>
	
	<dt>Web server</dt>
	<dd>Apache, lighttpd and nginx will all work. CGI mode is recommended and also some variant of 'suexec' (or a proper setup php-fpm pool)<br />NOTE: mod_rewrite or its equivalent is extremely useful.</dd>
</dl>

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


<dl>
	<dt>openssl</dt>       <dd>(compiled in for Debian, enabled manually in Arch Linux)</dd>
	<dt>php5-curl</dt>     <dd>Fetching files by HTTP.</dd>
	<dt>php5-gd</dt>       <dd>Image manipulation (scaling).</dd>
	<dt>php5-gmp</dt>      <dd>For Salmon signatures (part of OStatus).</dd>
	<dt>php5-intl</dt>     <dd>Internationalization support (transliteration et al).</dd>
	<dt>php5-json</dt>     <dd>For WebFinger lookups and more.</dd>
	<dt>php5-mysqlnd</dt>  <dd>The native driver for PHP5 MariaDB connections. If you use MySQL, 'php5-mysql' or 'php5-mysqli' may be enough.</dd>
</dl>

<p>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).</p>


{HEADING:SUBSECTION:better_performance:Better performance}

<p>For some functionality, you will also need the following extensions:</p>

<dl>
	<dt>opcache</dt>
	<dd>Improves performance a <em>lot</em>. Included in PHP, must be enabled manually in <tt>php.ini</tt> for most distributions. Find and set at least:  <tt>opcache.enable=1</tt></dd>
	
	<dt>mailparse</dt>
	<dd>Efficient parsing of email requires this extension. Submission by email or SMS-over-email uses this.</dd>
	
	<dt>sphinx</dt>
	<dd>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.</dd>

	<dt>gettext</dt>
	<dd>For multiple languages. Default on many PHP installs; will be emulated if not present.</dd>
	
	<dt>exif</dt>
	<dd>For thumbnails to be properly oriented.</dd>
</dl>

<p>You may also experience better performance from your site if you configure a PHP cache/accelerator. Most distributions come with "opcache" support. Enable it in your <tt>php.ini</tt> where it is documented together with its settings.</p>


{HEADING:SECTION:installation:Installation}

{HEADING:SUBSECTION:up_and_running:Getting it up and running}

<p>Installing the basic GNU Social web component is relatively easy, especially if you've previously installed PHP/MariaDB packages.</p>

<ol>

<li>
	<p>The source code is distributed using a git repository <a href="https://git.gnu.io/gnu/gnu-social">on GNU's Gitlab server</a>. There are two ways to download it:</p>
	
	<ul>
		<li>Use <a href="https://git-scm.com/">git</a> on your own computer to clone the repository. Once it is on your computer it is easy to download incremental updates.<br /> or;</li>
		<li>Download a zip or tarball from Gitlab's web interface. This way you won't need git but you will need to download the whole thing every time you update.</li>
	</ul>
	
	<p>If you want to use git, run the following command. It will download the whole repository and place it in a folder called <i>gnusocial</i>.</p>
	
	<p><tt>git clone https://git.gnu.io/gnu/gnu-social.git gnusocial</tt></p>
	
	<p>Then select the branch you wish to use.</p>
	
	<p>
		<tt>cd gnusocial</tt><br />
		<tt>git checkout master</tt><br />
		(or <tt>1.2.x</tt> or <tt>nightly</tt>)
	</p>

	<p>If you would like to download it directly instead, go to the <a href="https://git.gnu.io/gnu/gnu-social/tree/1.2.x">1.2.x</a>, <a href="https://git.gnu.io/gnu/gnu-social/tree/master">master</a> or <a href="https://git.gnu.io/gnu/gnu-social/tree/nightly">nightly</a> branch on the Gitlab web page. In the top-right corner there is a button to download a zip file containing that branch. If you press the drop-down arrow on the right you can access different types of archive.</p>
	
	<img src="{RES:tree_download.png}" alt="Download button on gitlab" class="figure" />
	
	<p>Unpack the tarball you downloaded on your Web server. Usually a command like this will work:</p>
   
	<p><tt>tar zxf gnu-social-*.tar.gz</tt></p>
   
	<p>...which will make a subdirectory in your current 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.)</p>
</li>

<li>
	<p>Whichever way you downloaded GNU social, move the files to a directory of your choosing in your Web root directory. Usually something like this will work:</p>

	<p>
		For a git repository:<br />
		<tt>cd gnusocial</tt><br />
		<tt>mkdir /var/www/gnusocial</tt><br />
		<tt>cp -rv * /var/www/gnusocial</tt>
	</p>
	
	<p>
		For a downloaded tarball:<br />
		<tt>mv gnu-social-x.y.z /var/www/gnusocial</tt>
	</p>

	<p>This will often make your GNU Social instance available in the <tt>gnusocial</tt> path of your server, like <tt>http://example.net/gnusocial</tt>. "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 <tt>http://social.example.net/</tt> or the like.

	<p>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.</p>

</li>

<li>
   
	<p>Make your target directory writeable by the Web server, please note however that 'a+w' will give <em>all</em> users write access and securing the webserver is not within the scope of this document.</p>

	<p><tt>chmod a+w /var/www/gnusocial/</tt></p>

	<p>On some systems, this will work as a more secure alternative:</p>

	<p>
		<tt>chgrp www-data /var/www/gnusocial/</tt><br />
		<tt>chmod g+w /var/www/gnusocial/</tt>
	</p>

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

</li>

<li>
   
	<p>You should also take this moment to make your 'avatar' and 'file' sub-directories writeable by the Web server. The <em>insecure</em> way to do this is:

	<p>
		<tt>chmod a+w /var/www/gnusocial/avatar</tt><br />
		<tt>chmod a+w /var/www/gnusocial/file</tt>
	</p>

	<p>You can also make the avatar, and file directories just writable by the Web server group, as noted above.</p>

</li>

<li>

	<p>Create a database to hold your site data. Something like this should work (you will be prompted for your database password):</p>

	<p><tt>mysqladmin -u "root" -p create social</tt></p>

	<p>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, though.</p>

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

</li>

<li>
   
	<p>Create a new database account that GNU Social will use to access the database. If you have shell access, this will probably work from the MariaDB shell:</p>

	<p>
		<tt>GRANT ALL on social.*</tt><br />
		<tt>TO 'social'@'localhost'</tt><br />
		<tt>IDENTIFIED BY 'agoodpassword';</tt>
	</p>

	<p>You should change the user identifier 'social' and 'agoodpassword' to your preferred new database username and password. You may want to test logging in to MariaDB as this new user.

</li>

<li>
   
	<p>In a browser, navigate to the GNU Social install script; something like:</p>

	<p><tt>https://social.example.net/install.php</tt></p>

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

</li>

<li>
   
	<p>You should now be able to navigate to your social site's main directory and see the "Public Timeline", which will probably be empty. You can now register new user, post some notices, edit your profile, etc.</p>

</li>
</ol>


{HEADING:SUBSECTION:fancy_urls:Fancy URLs}

<p>By default, GNU Social will use URLs that include the main PHP program's 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:</p>

<p>
	<tt>https://social.example.net/index.php/fred</tt><br />
    <tt>https://social.example.net/index.php?p=fred</tt>
</p>

<p>It's possible to configure the software to use fancy URLs so it looks like this instead:</p>

<p>
    <tt>https://social.example.net/fred</tt>
</p>

<p>These "fancy URLs" are more readable and memorable for users. To use fancy URLs, you must either have Apache 2.x with <tt>.htaccess</tt> enabled and mod_rewrite enabled, <em>OR</em> know how to configure "url redirection" in your server (like lighttpd or nginx).</p>

<ol>

<li>
	<p>See the instructions for each respective webserver software:</p>
	<ul>
		<li>For Apache, inspect the <tt>htaccess.sample</tt> file and save it as <tt>.htaccess</tt> after making any necessary modifications. Our sample file is well commented.</li>
		<li>For lighttpd, inspect the <tt>lighttpd.conf.example</tt> file and apply the appropriate changes in your virtualhost configuration for lighttpd.</li>
		<li>For nginx, inspect the <tt>nginx.conf.sample</tt> file and apply the appropriate changes.</li>
		<li>For other webservers, we gladly accept contributions of server configuration examples.</li>
	</ul>
</li>

<li>
	<p>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 <tt>config.php</tt> file:</p> 
	
	<p><tt>$config['site']['fancy'] = true;</tt></p>
</li>
       
</ol>

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

<p><tt>https://social.example.net/main/register</tt></p>



{HEADING:SUBSECTION:themes:Themes}

<p>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.</p>

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

<p>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:</p>

<dl>
	<dt>display.css</dt> <dd>a CSS2 file for "default" styling for all browsers.</a>
	<dt>logo.png</dt> <dd>a logo image for the site.</dd>
	<dt>default-avatar-profile.png</dt> <dd>a 96x96 pixel image to use as the avatar for users who don't upload their own.</dd>
	<dt>default-avatar-stream.png</dt> <dd>Ditto, but 48x48. For streams of notices.</dd>
	<dt>default-avatar-mini.png</dt> <dd>Ditto ditto, but 24x24. For subscriptions listing on profile pages.</dd>
</dl>

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


{HEADING:SUBSECTION:private:Private}

<p>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).</p>

<p>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.</p>

<p>Access to file attachments can also be restricted to logged-in users only:</p>

<ol>

<li>
	<p>Add a directory outside the web root where your file uploads will be stored. Use this command as an initial guideline to create it:</p>
	<p><tt>mkdir /var/www/gnusocial-files</tt></p>
</li>

<li>
	<p>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):</p>
	<p><tt>chmod a+x /var/www/gnusocial-files</tt></p>
</li>

<li>
	<p>Tell GNU social to use this directory for file uploads. Add a line like this to your <tt>config.php</tt>:</p>
	<p><tt>$config['attachments']['dir'] = '/var/www/gnusocial-files';</tt></p>
</li>

</ol>


{HEADING:SECTION:extra_features:Extra features}

{HEADING:SUBSECTION:sphinx:Sphinx}

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

<p>
    <tt>addPlugin('SphinxSearch');</tt><br />
    <tt>$config['sphinx']['server'] = 'searchhost.local';</tt>
</p>

<p>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.</p>

<p>See <tt>plugins/SphinxSearch/README</tt> for more details and server setup.</p>


{HEADING:SUBSECTION:sms:SMS}

<p>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.</p>

<p>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.</p>

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

<ol>

<li>
	<p>Run the SQL script <tt>carrier.sql</tt> in your StatusNet database. This will usually work:</p>

	<p><tt>mysql -u "statusnetuser" --password="statusnetpassword" statusnet &lt; db/carrier.sql</tt></p>

	<p>This will populate your database with a list of wireless carriers that support email SMS gateways.</p>
</li>
	
<li>
	<p>Make sure the maildaemon.php file is executable:</p>

	<p><tt>chmod +x scripts/maildaemon.php</tt></p>

	<p>Note that "daemon" is kind of a misnomer here; the script is more of a filter than a daemon.</p>
</li>

<li>
	<p>Edit <tt>/etc/aliases</tt> on your mail server and add the following line:</p>

	<p><tt>*: /path/to/statusnet/scripts/maildaemon.php</tt></p>
</li>

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

	<p><tt>newaliases</tt></p>

	<p>You may need to restart your mail server for the new database to take effect.</p>
</li>

<li>
	<p>Set the following in your <tt>config.php</tt> file:</p>

	<p><tt>$config['mail']['domain'] = 'yourdomain.example.net';</tt></p>
</li>

</ol>

{HEADING:SECTION:after_installation:After installation}

{HEADING:SUBSECTION:should_run_queue_daemons:Run queue daemons}

<p>By default GNU social tries to do regular work such as communicating with remote servers while it is handling HTTP requests for users. This is often insufficient. If possible you should run the <em>queue daemons</em>. Please refer to this section: {LINK:queue_daemons}.</p>

{HEADING:SUBSECTION:backups:Backups}

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

{HEADING:SUBSECTION:about_upgrading:Upgrading}

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 refer to this section: {LINK:upgrading}.</p>