tkr - Shared hosting installation

Warning

It has been a very long time since I've used shared hosting.

I've tried to confirm that these instructions are correct, but if you have any problems, or if you have suggestions for improving them, please send me an email.

Assumptions

  • Your server's web root is public_html
  • You are able to upload files to public_html
  • The application will be served as a subdirectory (e.g. https://example.com/tkr)

Prerequisites

Confirm that your hosting provider supports the PHP requirements

  • PHP 8.2+
  • The PDO and PDO_SQLITE PHP extensions

Installation

  1. Download the current release of tkr.
  2. Extract the contents of the file.
    Info

    The file contents will be extracted to a directory called tkr.

    • zip
      unzip tkr.v1.0.6.zip
    • tgz
      tar -xvzf tkr.v1.0.6.tgz
  3. Upload the tkr directory to your server's public_html directory using the tools provided by your hosting provider. After upload, the public_html directory should look like the diagram below.
    Info

    If you're hosting other content, then you'll have more files and directories under public_html. That's fine, as long as the tkr directory looks like this.

    public_html
└── tkr
    ├── config
    ├── examples
    ├── LICENSE
    ├── public
    ├── README.md
    ├── src
    ├── storage
    ├── templates
    └── tkr-setup.php
  4. Make the tkr/storage directory writable by all users using the tools provided by your hosting provider.
    • You need to grant the "read", "write", and "execute" permissions to the user, group, and world.
    • If you have shell access, you can do this with the chmod command from the public_html directory.
      chmod 0777 tkr/storage
    • Many shared hosting providers offer a UI like cPanel for site management. See this article for an overview of using cPanel to set directory permissions.