tkr - Configuration

Once tkr is installed, you have 2 options for configuring it:

  1. Command-line
  2. Web-based

Command-line installation

  1. ssh to your web server
  2. Navigate to the directory where you installed tkr
    • subdirectory: /var/www/my-site/tkr
    • subdomain: /var/www/tkr
  3. Run the setup script.
    php tkr-setup.php
  4. Answer the questions at the prompts.

Web-based configuration

  1. Open a browser and browse to your tkr URL, e.g.:
    • subdirectory: https://my-site.com/tkr
    • subdomain: https://tkr.my-site.com
  2. You'll be presented with the setup page. There are 3 sections:
    • User Settings tkr setup - user
      • username: (required) The name you'll use to log in to tkr. Not displayed publicly.
      • Display name: (required) An identifier that will be displayed to people who come to your site.
      • Website: (optional) A link to your personal website.
    • Site settings tkr setup - site
      • Title: (required) The title of the feed. Will display in the browser window, tabs, and RSS readers
      • Description: (required) A description of your feed. Will display on the main feed and in RSS readers
      • Base URL: (required) The domain where your feed is located. e.g.
        • subdirectory: https://my-site.com
        • subdomain: https://tkr.my-site.com
      • Base path: (required) The folder (if any) under the base URL from which tkr is served. e.g.
        • subdirectory: /tkr/
        • subdomain: /
      • Ticks per page: (required) The number of posts to diplay on each page of the frontpage and in feeds. Defaults to 25.
      • Tick delete window (hours): The amount of time after posting that you can delete a post. Defaults to 1 hour.
      • Strict accessibility: If enabled, adds an attribute to all selectable elements to force tab selection, overriding the default behavior of broswers that suppress it. Defaults to enabled.
      • Log level: The minimum log level to display. Defaults to INFO.
    • Password: tkr setup - site
      • New password: (required) The password you'll use to log in to tkr
      • Confirm new password: (required) Re-enter the password to make sure they match

After configuration, you're ready to start using tkr.