Skip to main content

Installation (v2)

Pre-flight checks

1. Check that your webserver supports:

  • PHP 7.2 or higher (PHP 8.1 ready).
  • sqlite3 extension.
  • PDO and pdo_sqlite extensions.
  • gd2 extension.

The dependencies are fairly standard (note the official Docker image for PHP does not include GD2, but you can rebuild the image with it included).

Upload files

2. Upload the files from the installation package to your web root directory (the top level directory that can be accessed via the browser on your server). This is usually, but not always, called public_html or sometimes htdocs.

3. Move the trust_path directory outside of the web root, ie. to the next higher directory. This ensures that nobody can access these files (which include your database and configuration files) via a web browser. You may also wish to change the name of this directory to something unpredictable, so that attackers can't guess it. The directory structure on your webserver should now look something like this:

Webserver directory structure

Set the paths

4. Open mainfile.php in your code editor. You need to specify the directory paths for the constants below. Make sure you end each path with a trailing slash. Upload the modified mainfile.php to your website root.

  • TFISH_ROOT_PATH: The path to your web root directory, eg. /home/accountname/public_html/
  • TFISH_TRUST_PATH: The path to your trust_path directory, eg. /home/accountname/random_trust_path/
  • TFISH_URL: The URL of your site, with trailing slash eg: http://yoursite.com/ (use https:// if you have an SSL certificate installed).
////////////////////////////////////////////////////////////
////////// You must configure the following paths //////////
////////////////////////////////////////////////////////////
define("TFISH_ROOT_PATH", "/home/youraccount/public_html/");
define("TFISH_TRUST_PATH", "/home/youraccount/random_trust_path/");
define("TFISH_URL", "https://yoursite.com/");
////////////////////////////////////////////////////////////
//////////////////// End configuration /////////////////////
////////////////////////////////////////////////////////////

If you are installing into a subjectory

If (and only if) you are installing Tuskfish into a subdirectory of your webroot, you need to edit .htaccess and add the subdirectory to the FallbackResource path. For example, if you installed into public_html/somedirectory you would edit the path as follows:

FallbackResource    /somedirectory/index.php

If you are installing into a Docker container

Some hacking is necessary in brief to: i) build a PHP image that includes GD2 support, ii) setup SSL termination via an NGINX reverse proxy / Let's Encrypt, and iii) make a couple of small configuration changes to support the routing.

Install!

5. Open http://yoursite.com/install/ in your browser and enter the following information:

  • Admin email: This will be your user name for the site.
  • Admin password: A minimum length of 15 characters is required (any shorter and the entire keyspace can be brute force searched).
  • Database name: Only alphanumeric and underscore characters are allowed. Good practice is to use something unpredictable.

Installation form

6. Submit the completed form and if everything goes well you will see an "Installation complete!" message and a link to your home page. If you see any error messages about being unable to find particular files then it is likely that you made a mistake in the directory paths when editing mainfile.php (refer to step 4).

Secure your site!

Please complete the installation process by securing your new website. This is mandatory and your website is not secure until you do so. I strongly recommend that you run the site over an encrypted connection (https://) to protect your login credentials. You can get free SSL/TLS certificates from Let's Encrypt.

Installation complete!

Copyright, all rights reserved.