Skip to content

Commit

Permalink
Updated the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@mystralkk
mystralkk committed Jun 11, 2022
1 parent 2682ac4 commit 97c3dd2
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 37 deletions.
37 changes: 18 additions & 19 deletions public_html/docs/english/install.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ <h2><a name="glossary">Glossary</a></h2>
<li>Directory: Same as a folder.</li>
<li>Path: A physical location on a server that describes where files and directories are. On Windows paths begin with the drive letter (<code>c:/inetpub/wwwroot/</code>), on *nix paths start at root (<code>/</code>) like (<code>/var/www/</code>)</li>
<li><a name="public_html">public_html</a>: Common name for the directory on a webserver that contains all files that are accessible via a URL (other common names: htdocs, www)</li>
<li>URL: Uniform Resource Locator, the address of a specific piece of information on the web (<code>http://www.foo.com/</code>)</li>
<li>URL: Uniform Resource Locator, the address of a specific piece of information on the web (<code>https://www.example.com/</code>)</li>
</ul>


Expand All @@ -52,7 +52,7 @@ <h3><a name="preinstall">Required Software</a></h3>
<li>fileinfo (To enable thumbnail creation of images in articles)</li>
</ul>

<p>You will also need either <a href="http://dev.mysql.com/downloads/">MySQL</a> 4.1.3 or later (<a href="http://mariadb.org/">MariaDB</a> 5.1 or later will also work), or <a href="http://www.postgresql.org/download/">PostgreSQL</a> 9.1.7 or greater.</p>
<p>You will also need either <a href="https://dev.mysql.com/downloads/">MySQL</a> 4.1.3 or later (<a href="https://mariadb.org/">MariaDB</a> 5.1 or later will also work), or <a href="https://www.postgresql.org/download/">PostgreSQL</a> 9.1.7 or greater.</p>

<p>When creating your database you will have to figure out what database collation you will use. Currently we recommend using UTF-8 (utf8mb4 for MySQL) character sets as this by far supports the most languages (and emojis as well). This means the database collation <strong>utf8mb4_general_ci</strong> for MySQL or <strong>en_US.UTF-8</strong> for PostgreSQL. Plus if you plan to have a multi language site this will ensure all your content (independent of language) will be able to be stored correctly as they will be able to handle the character sets of different languages. If you set your database collations to one of these, your character sets in the Geeklog Configuration will be updated automatically during the install.</p>

Expand Down Expand Up @@ -82,9 +82,6 @@ <h3><a name="preinstall">Required Software</a></h3>
<tr>
<td>Hebrew</td><td>utf-8</td><td>utf8/utf8mb4</td><td>utf8_general_ci/utf8mb4_general_ci</td><td>UTF8</td><td>he_IL.UTF-8</td>
</tr>
<tr>
<td>Polish</td><td>iso-8859-2</td><td>latin2</td><td>latin2_general_ci</td><td>LATIN2</td><td>?</td>
</tr>
<tr>
<td>Simplified Chinese</td><td>utf-8</td><td>utf8/utf8mb4</td><td>utf8_general_ci/utf8mb4_general_ci</td><td>UTF8</td><td>zh_CN.UTF-8</td>
</tr>
Expand All @@ -94,13 +91,15 @@ <h3><a name="preinstall">Required Software</a></h3>
</tbody>
</table>

<p>During the install process you can indicate whether to use UTF-8 as the default character set for your site independent of the language you are using. This will set the database character set to UTF-8. If you have <strong>checked</strong> this setting, make sure your database collation is compatible with the character set (usually for MySQL this is either <strong>utf8_general_ci</strong> or, if you wish to support emojis <strong>utf8mb4_general_ci</strong>). <em>Checking this will not change the collation of your database, this must be done manually before you proceed with the install.</em> If you leave 'Use UTF-8' unchecked your installs default language selection character set will be used.</p>
<p>Since Geeklog 2.2.2, we require UTF-8 as the default character set for your site and as the database character set on fresh install, independent of the language you are using. Please make sure your database collation is compatible with UTF-8 (usually for MySQL this is either <strong>utf8_general_ci</strong> or, if you wish to support emojis <strong>utf8mb4_general_ci</strong>).</p>

<p>When upgrading from an older version, the database character will NOT be changed. After upgrading, if you want to change the database character set to UTF-8 using a tool like <a href="https://www.phpmyadmin.net/">phpMyAdmin</a> or <a href="https://www.adminer.org/">Adminer</a>, you will manually have to change the value of $_DB_charset in "db-config.php" to 'utf8' or 'utf8mb4' and the value of $_CONF['default_charset'] in "siteconfig.php" to 'utf-8' as well.</p>

<p>Geeklog supports other languages that are not listed in the install. The easiest way to support these languages is to use a UTF-8 database collation and then once the install is complete go into the Geeklog Configuration and change the language to the one you want. If you rather use the database collation specific for your language you will either have to pick an install language that uses the same character set, or after the install, manually update the settings in siteconfig.php and dbconfig.php files to use the correct character sets. You will then have to update your collation for the Geeklog database, tables and columns. To find out what character set the other languages use, you will need to check that actual language file located in the Geeklog languages directory.</p>
<p>Geeklog supports other languages that are not listed in the install. The easiest way to support these languages is to use a UTF-8 database collation and then once the install is complete go into the Geeklog Configuration and change the language to the one you want.</p>

<p><strong>Note for PostgreSQL users:</strong> Geeklog currently requires that the Postgres option <span class="tt">standard_conforming_strings</span> is set to <span class="tt">off</span> (it is <span class="tt">on</span> by default as of PostgreSQL 9.1).</p>

<p><strong>Note for MySQL users:</strong> As of version 5.5.3 MySQL supports 4-byte characters. In this case if you want to support for example emoji icons characters which are 4 bytes you will need to use a collation which supports it like utf8mb4_general_ci. For existing Geeklog databases which are using a different collation you can use a tool like phpMyAdmin to change your database default collation along with all the table collations. Be warned depending on what your initial collation is you may need to also update the data in your tables.</p>
<p><strong>Note for MySQL users:</strong> As of version 5.5.3 MySQL supports 4-byte characters. In this case if you want to support for example emoji icons characters which are 4 bytes you will need to use a collation which supports it like utf8mb4_general_ci. For existing Geeklog databases which are using a different collation you can use a tool like <a href="https://www.phpmyadmin.net/">phpMyAdmin</a> or <a href="https://www.adminer.org/">Adminer</a> to change your database default collation along with all the table collations. Be warned depending on what your initial collation is you may need to also update the data in your tables.</p>

<h3><a name="things_you_should_know">Things You Should Know</a></h3>

Expand All @@ -122,17 +121,17 @@ <h2><a name="install">New Installation</a></h2>
</li>
<li>
<p>Unpack the downloaded tarball file by running: </p>
<p><code>tar -zxvf geeklog-2.2.1sr1.tar.gz</code> </p>
<p><code>tar -zxvf geeklog-2.2.2.tar.gz</code> </p>

<p><strong>Note:</strong> Some users have reported that WinZip corrupts certain Geeklog files during decompression. This will cause errors during the installation process. You are strongly urged not to use WinZip. Try <a href="http://www.7-zip.org/">7-Zip</a> or <a href="http://www.rarlab.com/">WinRAR</a> if you must decompress the file locally.</p>
<p><strong>Note:</strong> Some users have reported that WinZip corrupts certain Geeklog files during decompression. This will cause errors during the installation process. You are strongly urged not to use WinZip. Try <a href="https://www.7-zip.org/">7-Zip</a> or <a href="https://www.rarlab.com/">WinRAR</a> if you must decompress the file locally.</p>
</li>
<li>
<p>Create a blank MySQL or PostgreSQL database and a user account with privileges to modify it. For MySQL this includes a user that has been granted all privileges on the database (including LOCK which is not included in the ALL permission). Your hosting provider may have already set up a database and account for you, contact them if you need assistance with this step.</p>
</li>
<li>
<p>Place the contents of <code>geeklog-2.2.1sr1/public_html/</code> into your web root directory on your web server. The web root directory is often named "public_html", "htdocs", or "www".</p>
<p>Place the contents of <code>geeklog-2.2.2/public_html/</code> into your web root directory on your web server. The web root directory is often named "public_html", "htdocs", or "www".</p>

<p>Next, place the remaining contents of <code>geeklog-2.2.1sr1/</code> into either the parent directory of your root web directory (recommended) or any other non public folder and the installation wizard will attempt to locate them automatically. If it cannot you will be asked to specify their paths during installation. This is done as a security measure to prevent access to Geeklog system files by Internet users. </p>
<p>Next, place the remaining contents of <code>geeklog-2.2.2/</code> into either the parent directory of your root web directory (recommended) or any other non public folder and the installation wizard will attempt to locate them automatically. If it cannot you will be asked to specify their paths during installation. This is done as a security measure to prevent access to Geeklog system files by Internet users. </p>

<p><strong>Note:</strong> If your hosting provider does not allow you to place files outside of your root web directory:</p>
<ul>
Expand All @@ -144,7 +143,7 @@ <h2><a name="install">New Installation</a></h2>
<li>
<p>Open your browser and navigate to the Geeklog installation wizard file <code>admin/install/index.php</code> on your web server. The path to this file will depend on where you chose to put the Geeklog files on your web server. The default location is: </p>

<p><code>http://[your_geeklog_site]/admin/install/index.php</code></p>
<p><code>https://[your_geeklog_site]/admin/install/index.php</code></p>

<p>The Geeklog installation wizard was designed to automate the install process. Simply follow the installation steps.</p>
</li>
Expand All @@ -170,12 +169,12 @@ <h2><a name="upgrade">Upgrading</a></h2>
</li>
<li>
<p>Unpack the downloaded tarball file by running: </p>
<p><code>tar -zxvf geeklog-2.2.1sr1.tar.gz</code> </p>
<p><code>tar -zxvf geeklog-2.2.2.tar.gz</code> </p>

<p><strong>Note:</strong> Some users have reported that WinZip corrupts certain Geeklog files during decompression. This will cause errors during the installation process. You are strongly urged not to use WinZip. Try <a href="http://www.7-zip.org/">7-Zip</a> or <a href="http://www.rarlab.com/">WinRAR</a> if you must decompress the file locally.</p>
<p><strong>Note:</strong> Some users have reported that WinZip corrupts certain Geeklog files during decompression. This will cause errors during the installation process. You are strongly urged not to use WinZip. Try <a href="https://www.7-zip.org/">7-Zip</a> or <a href="https://www.rarlab.com/">WinRAR</a> if you must decompress the file locally.</p>
</li>
<li>
<p>Place the contents of <code>geeklog-2.2.1sr1/</code> into the same directory your old installation was located. For instance, if your old Geeklog was in <code>/usr/home/www/geeklog/</code>, then your new installation should also be in <code>/usr/home/www/geeklog/</code>.</p>
<p>Place the contents of <code>geeklog-2.2.2/</code> into the same directory your old installation was located. For instance, if your old Geeklog was in <code>/usr/home/www/geeklog/</code>, then your new installation should also be in <code>/usr/home/www/geeklog/</code>.</p>
</li>
<li>Depending on the version you're upgrading from:
<ul>
Expand All @@ -186,7 +185,7 @@ <h2><a name="upgrade">Upgrading</a></h2>
<li>
<p>Open your browser and navigate to the Geeklog installation wizard file <code>admin/install/index.php</code> on your web server. The path to this file will depend on where you chose to put the Geeklog files on your web server. The default location is: </p>

<p><code>http://[your_geeklog_site]/admin/install/index.php</code></p>
<p><code>https://[your_geeklog_site]/admin/install/index.php</code></p>

<p>The Geeklog installation wizard was designed to automate the upgrade process. Simply follow the installation steps.</p>
</li>
Expand Down Expand Up @@ -248,7 +247,7 @@ <h3>Common errors (Line numbers will vary):</h3>
<p><strong>Answer:</strong> All of the above cases (and similar "parse error" messages you may get for lib-common.php, typically with a line number in the 3000 or 4000 range) indicate a corrupted <code>lib-common.php</code> file.</p>
<p>As noted at the top of this document this is usually caused by one of the following:</p>
<ul>
<li>Uncompressing the tarball with certain versions of WinZip (try using <a href="http://www.7-zip.org/">7-Zip</a> or <a href="http://www.rarlab.com/">WinRAR</a> instead)</li>
<li>Uncompressing the tarball with certain versions of WinZip (try using <a href="https://www.7-zip.org/">7-Zip</a> or <a href="https://www.rarlab.com/">WinRAR</a> instead)</li>
<li>Editing the lib-common.php with Dreamweaver or other so-called WYSIWYG HTML editors (use a simple text editor instead)</li>
<li>Editing the lib-common.php with "on-site" text editors built into tools like Cpanel (again, use a simple text editor instead)</li>
</ul>
Expand Down Expand Up @@ -296,7 +295,7 @@ <h3>Common errors (Line numbers will vary):</h3>
<p>Try entering the text of the error message on Google. Chances are you will find someone else who had the same problem and fixed it. And sometimes searching for a specific error will cause Google to bring up broken pages that have the same error.</p>
</li>
<li>
<p>Even <a href="support.html">more support options</a> are listed elswhere in this documentation.</p>
<p>Even <a href="support.html">more support options</a> are listed elsewhere in this documentation.</p>
</li>
</ol>

Expand Down

0 comments on commit 97c3dd2

Please sign in to comment.