Install

Installation

In all cases, the following steps need to be taken once the web server is up and running and the database has been created.

The details may be slightly different (especially steps 4 to 7) depending on your MySQL client or whether running WIKINDX on a hosted web environment or locally but the principles are the same. Assume we are running a http://wikindx.test website installed in a /var/www/wikindx folder of the web server.

The password is deliberately simple for the example. You MUST NOT use it because it offers no security. Generate a strong and random password of at least 16-20 characters with a password generator such as https://www.motdepasse.xyz/. NEVER use special characters. They are a source of problems for some programs like backup tools.

  1. Download the source code of the core from the SourceForge Files section.

  2. Uncompress the source code into a folder on your computer – this will create a wikindx folder.

  3. Copy the files and folders from the uncompressed wikindx folder to /var/www/wikindx that you setup on previous chapter.

  4. Copy the config.php.dist file to config.php.

  5. Edit the config.php file and set the database connection parameters (more if needed). Each setting is documented in the file.

// See https://www.php.net/manual/en/mysqli.construct.php
public $WIKINDX_DB_HOST = "localhost";
public $WIKINDX_DB = "wikindx";
public $WIKINDX_DB_USER = "wikindx";
public $WIKINDX_DB_PASSWORD = "wikindx";
  1. Adjust permissions before trying to use the software otherwise you will encounter artificial errors. In particular, set permissions from the site’s root folder by following the instructions in the “Permissions” section below. Example (not secure):
cd /var/www/wikindx
chown -R www-data:www-data *
chmod -R 777 *
  1. Optionally, ensure the web server environment is running (with ps, top, or an other process monitoring software).

  2. Type in the WIKINDX address in the web browser – if running locally, this will be http://wikindx.test/ – to complete your WIKINDX configuration. You will go through the following steps:

    • If the PHP version is wrong, you will be prompted to correct this.
    • If mandatory PHP extensions are missing, you will be prompted to correct this.
    • If the config.php file is missing, you will be prompted to correct this.
    • Missing folders will be created (cache and data).
    • If anything is not writeable, you will be prompted to correct this.
    • If the MySQL version is wrong, you will be prompted to correct this.
    • The database will be populated with tables.
    • Setup of the Super Administrator account.
  3. Go to Admin > Configure menu and set global preferences.

  4. Go to WIKINDX > My WIKINDX menu and set the Super Administrator preferences.

  5. Finally install and enable components from the Components Manager (Admin > Components menu).

Your single-user install of WIKINDX is ready. Have fun!

Permissions

If you are running WIKINDX locally on Windows (using something like XAMPP), you can skip the permissions step as the folders will be writable by default.

If you are running a Unix-type machine, WIKINDX will not function correctly if various folders and files within them are not writeable for the web server user.

The install process will show with current Unix permissions. You should made folders and files readable and writeable (along with their contents) for the web server user. The web server user can be the owner and/or the group of those folders. So you have to modify, the owner, the group and the permission bits according to the particular configuration of your web server (usually web servers use ’nobody’, ‘www-data’, or ‘daemon’ users), PHP and file transfer software.

You may also be required to add the execution bit in certain cases. The same rights apply to files in these folders, but this script does not check them for performance reasons. See the chmod, web server and PHP manuals for details. r = readable; w = writable ; x = executable.

The following commands should give a good result in the general case where the web server user should be “user” or “group” (760, 670 or 770 should work):

cd /var/www/wikindx
chown -R www-data:www-data *
chmod -R 777 *

As a last resort you can use the 777 mode but it is a major security flaw. You shouldn’t need this extreme case if the owners are set up correctly.

When your web site code is a clone of the SVN repository (not recommended) the owner of the root SVN folder, .svn folders, and all files and folders under .svn need to be readable, writable and executable (7).

WIKINDX creates folders with 777 permissions so that it works in all cases, notably the installation of the core and components, for managing caches and data. You can correct it later if you want the best possible security.

WARNING: if you started to install without taking into account the permissions you may find yourself blocked with a blank page because of the template system which creates incomplete cached files. Each time you configure permissions, delete all the files and folders found under the cache/templates/ tree.

Note

The data/files/ directory is used for the temporary storage of RTF, RIS, Endnote, BibTeX and other files for the user to download. The scripts within WIKINDX will mark these files for deletion after so many seconds have passed since their last modification (you can configure this In WIKINDX: Admin > Configure menu). This doesn’t necessarily mean that they will be immediately deleted: they will be deleted the next time someone logs on.