Add prerequisites info about the 3x branches and web host configuration

This commit is contained in:
Thomas Karpiniec 2016-01-25 19:06:16 +11:00
parent 9da42a7fef
commit 040c9682fb

View File

@ -1,5 +1,32 @@
{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 should really 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>