Tk-Wiki

Web: https://github.com/tropotek/tkwiki
Author: Tropotek http://www.tropotek.com/

A WIKI/CMS that is easy to use for people that want a website to store info fast. Perfect for projects that require online documentation and can be edited by teams.

Features:

• The ability to add CSS and JavaScript within each page.
• Create/link pages within the WYSIWYG editor.
• Edit the nav menu within the wiki
• Bootstrap 5+ basic template
• Save 'Secret' site access details for the website and share them within groups
• QR-Code reader for generating One Time Password (OTP) for shared Secrets

Contents

• Installation
• Upgrading

Installation

• Set up a database for the site and keep the login details handy.
• Make sure you have the latest version of composer [https://getcomposer.org/download/].
• Use the following commands:

  $ git clone https://github.com/tropotek/tkwiki.git
  $ cd tkwiki
  $ composer install

• You will be asked a number of questions to set up the environment settings.
• Create a new admin user to log into the site:

  $ ./bin/cmd adm {username}

• Edit the /config.php file to your required settings.
• To enable debug mode and logging edit the /config.php file:

      // Enable Debug in a dev environment
      $config['env.type'] = 'dev';
      // Setup dev environment
      if ($config->isDev()) {
          // Send all emails to the debug address
          $config['system.debug.email'] = 'dev@example.com';
          // allow any password without strict validation
          $config['auth.password.strict'] = false;
      }

• Change the permissions of the /data/ folder to be writable by your server.
• Browse to the site URL and login with the admin user credentials.

Upgrading

Upgrade the site by the CLI command;

$ cd {siteroot}
$ ./bin/cmd ug

Manual upgrade process if the above fails:

$ git reset --hard
$ git checkout 8.0.0    // Use the latest tag version here
$ composer update

Warning: Upgrading could potentially break the site. Be sure to back up all DB's and site /data files before running these commands.

Docker Development

Create a .env from the .env.example file and edit the values.

Start the docker containers:

docker-compose up --build -d
docker compose down

Then enter a terminal in the container:

docker exec -it tkwiki_app_1 /bin/bash

Run these commands from the container terminal

Install the dependencies with composer:

composer install
# or
docker exec -it tkwiki_app_1 composer install 

Enter your details when prompted

Set the DB hostname [localhost]: db
Set the DB port [3306]: 
Set the DB name: wiki
Set the DB user: dev
Set the DB password: ****
Saving config.php
Creating .htaccess file
What is the base URL path [/]:

Now visit the site at https://localhost:440

HTTP ports are not implemented yet.