MindTouch Administration Guide

No headers

View tutorials for:

Beginner tutorials

Backup MindTouch

Export MindTouch pages and files: The scripts below will export MindTouch pages as HTML and export the files as the raw files. This is currently only targeting the main hierarchy. This isn't a supported method but can be added to, to streamline.

Using Gmail for external SMTP server: If you want to use Gmail as your external SMTP server in MindTouch, follow these steps

Intermediate tutorials

Backup MindTouch

Backup MindTouch installed on Linux 0 of 2 found this helpful: This tutorial will run through how to backup MindTouch when it is deployed on Linux. This also works for the VMware install of MindTouch as the base operating system is Linux.
Backup MindTouch installed on Windows: This tutorial will walk through how to backup MindTouch when it is installed on Windows.
Export MindTouch pages and files: The scripts below will export MindTouch pages as HTML and export the files as the raw files. This is currently only targeting the main hierarchy. This isn't a supported method but can be added to, to streamline.

Customizations

Changing User Page Tabs 1 of 1 found this helpful: Looking to customize your User Page experience? One quick way is to change the order in which tabs are loaded on User Pages in MindTouch TCS.

Editor

Change editor layout: Change the buttons that are shown and hidden for the default MindTouch editor

Using Gmail for external SMTP server: If you want to use Gmail as your external SMTP server in MindTouch, follow these steps

Migrating MindTouch

Migrating MindTouch from one Windows server to another: Migrate MindTouch running natively on Windows to a separate Windows server.
Migrating MindTouch from Windows to Linux: This will review how to migrate MindTouch installed on Windows to a new install of MindTouch installed on Linux.
Migrating MindTouch from one Linux server to another 1 of 1 found this helpful: This reviews how to migrate MindTouch from instance to another when MindTouch is installed on Linux on both servers.
Migrating from Wik.is to a new MindTouch install 2 of 2 found this helpful: This tutorial walks through the steps of migrating a wik.is installation to a new MindTouch installation.

Performance

Disabling IIS app pool recycling: This tutorial covers how to disable app pool recycling in IIS to improve initial load response of MindTouch when running on Windows. This will also alleviate FastCGI errors.
Enabling Checkdeki: checkdeki is a BASH script that is run as a cron job. It checks the status of your MindTouch install and if it detects that it isn't running properly, it will automatically restart the MindTouch API.
Increase Performance of Recent Changes: This tutorial will cover how to implement caching for Recent Changes. Goal Recent Changes is an expensive page to load due to the amount of processing required. Within this page, the most recent changes to pages are queried, and then diff'ed to provide an overview of recent activity. Because of this, loading Recent Changes can occasionally take longer to load than normal pages, and in extreme cases cause a load on the server. One way to improve the performance of Recent Changes is to implement caching practices. We have done so via the following config key/value pairs: key: value: feed/diff-cache true feed/cache-ttl 300 To configure these, simply add these two pairs within Control Panel-->Configuration-->Advanced Config. Please see the below screenshot demonstrating this: The "feed/diff-cache" key will allow page revisions to be cached for long-term purposes. Each page edit is considered a unique revision. Since individual revisions will never change (only future edits, creating a specific revision for each edit), caching the differences between revisions greatly improves performance. The "feed/cache-ttl" key sets a Time to Live for how often the feed is cached as a whole. What's Next Once in place, this caching configuration should assist in the performance of loading Recent Changes. Related

Upgrading MindTouch

Upgrade MindTouch on CentOS/Red Hat: Upgrade your MindTouch installation if it is running on Red Hat/CentOS.
Upgrade MindTouch on Debian/Ubuntu 2 of 2 found this helpful: Upgrade your MindTouch installation if it is running on Debian/Ubuntu.
Upgrading Debian from Etch to Lenny: In order to receive security updates, MindTouch should be running on a supported version of Debian; at the time of writing the only supported version is v5.0, codenamed "Lenny". Debian is the default operating system for the MindTouch distributed VMware appliance. This tutorial runs through how to upgrade the previous version of the appliance, running on Debian v4.0 (Etch). (After a new release of Debian, the previous release gains the alias oldstable and is supported for one further year.)
Upgrading MindTouch on Windows: Upgrade MindTouch that is installed on Windows Server 2003 or Windows Server 2008
Upgrading MindTouch VMware Appliance: This documentation covers how to upgrade your MindTouch installation to the current stable release of MindTouch.

Advanced tutorials

Backup MindTouch

Export MindTouch pages and files: The scripts below will export MindTouch pages as HTML and export the files as the raw files. This is currently only targeting the main hierarchy. This isn't a supported method but can be added to, to streamline.

Using Gmail for external SMTP server: If you want to use Gmail as your external SMTP server in MindTouch, follow these steps

MySQL Database

Verify database schema using CheckDb: mindtouch.deki.checkdb.exe is a tool to check the integrity of a MindTouch database. CheckDb runs a series of tests to verify the database table schema, indexes, character set, etc. As MindTouch evolves, we will continue to add new tests to CheckDb. CheckDb is an executable that can be run on it's own but each test is also an NUnit test which can be run from the NUnit GUI or console.

Performance

Increasing FastCGI Timeout 0 of 1 found this helpful: This tutorial will cover how to modify FastCGI timeouts within MindTouch. Goal In rare cases, large processing operations within MindTouch can cause FastCGI timeouts on Windows installations. If the operation is valid and should be forced, increasing the FastCGI timeout threshold will be necessary. This threshold is defined within "C:\Program Files\MindTouch\MindTouch\redist\FastCGI\fcgiext.ini" via the following variables: ActivityTimeout=60 RequestTimeout=90 "ActivityTimeout" is the length of time the FastCGI handler process will wait for activity during script execution. "RequestTimeout" is the maximum length of time possible for the execution of the script in question. The above default variables are displayed in seconds. What's Next After having increased your FastCGI timeout threshold, try performing the operation once more. If necessary, increase the threshold as needed. Related

Add a Troubleshooting Page

Troubleshooting pages are for users to identify reasons and fixes for problems. To mark a troubleshooting page, add the tag article:task-troubleshooting to any page.

View references for:

Features
Samples

Features

MySQL Database

MindTouch database schema: This is an overview of the MindTouch database schema in MySQL.

Advanced content searches 8 of 10 found this helpful: This document covers how to perform advanced searches within MindTouch.
File extensions that are indexed: MindTouch's built in search will index the contents of supported attachments

This guide provides documentation on managing your MindTouch installation after it has been deployed.

Table of Contents

Topics