Geeklog

Installing Geeklog

Glossary

Installation Requirements

Required Software

To install and use Geeklog you will need to have a server running Apache or Microsoft IIS with PHP 5.6.4 or higher installed (PHP 7.X is supported). PHP extensions required include:

You will also need either MySQL 4.1.3 or later (MariaDB 5.1 or later will also work), or PostgreSQL 9.1.7 or greater.

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 utf8mb4_general_ci for MySQL or en_US.UTF-8 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.

Remember this is an important decision as changing your database collation at a later date will most likely require you to manually convert your database content.

Below are the Language character sets supported by the Geeklog Install along with their corresponding database character sets and recommended database collations:

LanguageSite Language Character SetMySQL DB Character SetMySQL DB CollationPostgreSQL DB Character SetPostgreSQL DB Collation
Englishiso-8859-1latin1latin1_swedish_ciLATIN1?
English (UTF-8)utf-8utf8/utf8mb4utf8_general_ci/utf8mb4_general_ciUTF8en_US.UTF-8
Japaneseutf-8utf8/utf8mb4utf8_general_ci/utf8mb4_general_ciUTF8ja_JP.UTF-8
Germaniso-8859-15latin1latin1_swedish_ciLATIN9?
Hebrewutf-8utf8/utf8mb4utf8_general_ci/utf8mb4_general_ciUTF8he_IL.UTF-8
Polishiso-8859-2latin2latin2_general_ciLATIN2?
Simplified Chineseutf-8utf8/utf8mb4utf8_general_ci/utf8mb4_general_ciUTF8zh_CN.UTF-8
Traditional Chineseutf-8utf8/utf8mb4utf8_general_ci/utf8mb4_general_ciUTF8zh_TW.UTF-8

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 checked this setting, make sure your database collation is compatible with the character set (usually for MySQL this is either utf8_general_ci or, if you wish to support emojis utf8mb4_general_ci). Checking this will not change the collation of your database, this must be done manually before you proceed with the install. If you leave 'Use UTF-8' unchecked your installs default language selection character set will be used.

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.

Note for PostgreSQL users: Geeklog currently requires that the Postgres option standard_conforming_strings is set to off (it is on by default as of PostgreSQL 9.1).

Note for MySQL users: 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.

Things You Should Know

Before installing Geeklog for the first time, please make sure you:

New Installation

  1. Download the current version of Geeklog from Geeklog.net.

  2. Unpack the downloaded tarball file by running:

    tar -zxvf geeklog-2.2.1sr1.tar.gz

    Note: 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 7-Zip or WinRAR if you must decompress the file locally.

  3. 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.

  4. Place the contents of geeklog-2.2.1sr1/public_html/ into your web root directory on your web server. The web root directory is often named "public_html", "htdocs", or "www".

    Next, place the remaining contents of geeklog-2.2.1sr1/ 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.

    Note: If your hosting provider does not allow you to place files outside of your root web directory:

  5. Open your browser and navigate to the Geeklog installation wizard file admin/install/index.php 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:

    http://[your_geeklog_site]/admin/install/index.php

    The Geeklog installation wizard was designed to automate the install process. Simply follow the installation steps.

  6. Once you have completed the installation be sure to delete the admin/install directory. Also, read the first story on your Geeklog site to learn how to log in as the administrator and change the default password.

Upgrading

Upgrading is no different than a New Installation except your database already exists and needs to be updated.

Take extreme care to back up any files from your current Geeklog installation that have any custom code in them, especially lib-custom.php (where all custom code should reside). Be sure to back up any modified themes, images, and static pages from your current installation.

Also, please be sure to back up your database. We can't stress the importance of backing up your files and database enough.

YOU HAVE BEEN WARNED.

  1. Download the current version of Geeklog from Geeklog.net.

  2. Unpack the downloaded tarball file by running:

    tar -zxvf geeklog-2.2.1sr1.tar.gz

    Note: 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 7-Zip or WinRAR if you must decompress the file locally.

  3. Place the contents of geeklog-2.2.1sr1/ into the same directory your old installation was located. For instance, if your old Geeklog was in /usr/home/www/geeklog/, then your new installation should also be in /usr/home/www/geeklog/.

  4. Depending on the version you're upgrading from:
  5. Open your browser and navigate to the Geeklog installation wizard file admin/install/index.php 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:

    http://[your_geeklog_site]/admin/install/index.php

    The Geeklog installation wizard was designed to automate the upgrade process. Simply follow the installation steps.

  6. Once you have completed the upgrade be sure to delete the admin/install directory.

Migrating

The install script's "Migrate" option will help you move your site to another server or domain name. It will update the configuration information stored in the database and can also update URLs in content, such as articles (in case the domain name or URL of your Geeklog site changed).

After clicking on "Migrate", you will have to enter the database credentials for your (new) database server, as usual. Note that you don't need to enter a table prefix, as the Migrate option will detect it automatically.

You then have the option to upload a database backup from your computer, to import from a backup that's already on the server (in Geeklog's backups directory), or you can use the current content of the database, in case you already imported it through other means.

Note: Uploading a backup file from your computer will only work as long as the size of the backup file is below the server's max. upload limit. The max. allowed size will be displayed when you select this option. If your backup file is over that limit, try compressing it (zip or gzip should work) or use one of the other two options.

Common Problems and Troubleshooting

Before you go any further, please open siteconfig.php and double check your paths! Bad paths, or typos in the paths, will cause all sorts of errors in Geeklog.

When you get an error message, please read it carefully. Even if you're not familiar with PHP, it will give you a hint about what is wrong. Pay special attention at the paths contained in the error message. As mentioned before, wrong paths are the most common cause for problems.

If you get more than one error message, always start with the very first error - the others will often go away automatically once you've fixed the first one.

Common errors (Line numbers will vary):

If you still have problems, please do one or more of the following:

  1. Go to https://www.geeklog.net and check out the Support section. The Support section includes a FAQ, forums, and a search system (try searching for the error message, if you get one).

  2. Visit the mailing list archives at http://lists.geeklog.net/pipermail/geeklog-users/. You can also subscribe to the mailing list and post your question to the Geeklog community.

  3. Try the chat room at Gitter (in the Geeklog room). Please have all your path and database information in siteconfig.php and db-config.php readily available.

  4. 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.

  5. Even more support options are listed elswhere in this documentation.