thomask
/
social-doc
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Cleanup and more interlinking in installing chapter

This commit is contained in:
Thomas Karpiniec 2016-02-07 20:23:53 +11:00
parent 2118e0d8d1
commit d5daa1c035
1 changed files with 19 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
html/admin/installing.html
View File

@ -2,30 +2,30 @@
{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>
<p>GNU social has three different branches of development offering a range of choices between stability and the latest features.
<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>
<dd><tt>master</tt> 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>
<dd><tt>nightly</tt> 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>When you download the source code in {LINK:up_and_running} you will need to know which branch you want to install. You can always move to a more unstable branch but going backwards is not guaranteed to 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 use HTTPS to encrypt all communications with your GNU social instance. Until recently it cost money to get a trusted certificate but now the Let's Encrypt project enables you to <a href="https://letsencrypt.org/howitworks/">obtain a trusted certificate at no cost</a>.</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 are thinking about starting with HTTP and setting up encryption later, don't do that. You may have problems if you start with HTTP and later move to HTTPS.</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>
<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 also requires you to have {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}
@ -33,7 +33,7 @@
<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>
<dd>For newer versions, some functions that are used may be disabled by default, such as the <tt>pcntl_*</tt> family. See the section on {LINK:queue_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>
@ -42,7 +42,7 @@
<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>
<p>Your PHP installation must include the following PHP extensions for a functional setup of GNU social:</p>
<dl>
@ -55,7 +55,7 @@
<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>
<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 <tt>php.ini</tt> file (mostly <tt>php5-gmp</tt>).</p>
{HEADING:SUBSECTION:better_performance:Better performance}
@ -138,13 +138,13 @@
<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>
<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 {LINK:fancy_urls} support.</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>Make your target directory writeable by the Web server, please note however that <tta+w</tt> 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>
@ -155,20 +155,20 @@
<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>
<p>If your Web server runs as another user besides <tt>www-data</tt>, try that user's default group instead. As a last resort, you can create a new group like <tt>gnusocial</tt> 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>You should also take this moment to make your <tt>avatar</tt> and <tt>file</tt> 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>
<p>You can also make the avatar, and file directories just writable by the web server group, as noted above.</p>
</li>
@ -178,7 +178,7 @@
<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>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>
@ -186,7 +186,7 @@
<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>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 />
@ -194,7 +194,7 @@
<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.
<p>You should change the user identifier <tt>social</tt> and <tt>agoodpassword</tt> to your preferred new database username and password. You may want to test logging in to MariaDB as this new user.
</li>
@ -210,7 +210,7 @@
<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>
<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 users, post some notices, edit your profile, etc.</p>
</li>
</ol>