TURNKEYGNU / LINUX

Documentation

Documentation

Install, operate, customize, and troubleshoot TurnKey GNU/Linux.

Choose a path

What do you need to do?

146 current guides

Go deeper

Browse focused directories

Appliance guides

Notes for WordPress, OpenVPN, File Server, GitLab, and other appliances.

Open directory

Tools and components

Reference for TKLBAM, Confconsole, Webmin, inithooks, and build tools.

Open directory

Support

Self-help, troubleshooting, and useful problem reports.

Open directory
Complete documentation indexBrowse all 146 current guides alphabetically
  1. "Self help", reporting problems and getting support
  2. Access via SSH
  3. Add "hosts" entry on your local PC
  4. Additional resources
  5. Administer your TKL server: How to connect to TKL appliances, edit and upload files, etc
  6. Advanced usage (configuration hook scripts)
  7. Amazon EC2 / TurnKey Hub - Fix grub boot issues / recover root password
  8. Amazon EC2 cloud server deployment
  9. Amazon EC2: How to configure web/email server for mailout/mailing lists
  10. Amazon EC2: How to expand the size of an existing root volume
  11. Appliance installation tutorial with VirtualBox
  12. Appliance Installation Tutorial with VirtualBox (New)
  13. Appliance-specific notes
  14. Applying a patch (tutorial)
  15. Automatic security updates
  16. Bare Metal ProxMox HyperViser Installation.
  17. Build a new appliance with TKLDev
  18. CloudTask - parallel batch execution with auto-launched cloud servers
  19. cloudtask-destroy-workers: Destroy cloud workers
  20. cloudtask-launch-workers: Pre-allocate workers
  21. cloudtask: Execute a task in the cloud
  22. Command-line tools
  23. Confconsole - Let's Encrypt
  24. Confconsole - Mail relay
  25. Confconsole - Networking
  26. Confconsole - Plugins system (for devs)
  27. Confconsole - Proxy settings
  28. Confconsole - Region config
  29. Confconsole - System settings
  30. Confconsole - TurnKey Configuration
  31. Configure apt-get internet access via a proxy
  32. Considerations For Windows Users
  33. Debian documentation for TurnKey GNU/Linux
  34. Deploying a Ruby on Rails application
  35. Design overview
  36. Design overview
  37. Django
  38. Docker
  39. Domain Controller
  40. Drupal7
  41. Drupal8
  42. Email: Send emails via SMTP Relay
  43. Example usage scenario
  44. Example usage scenario
  45. FAQ (Frequently Asked Questions)
  46. Features, components and tools
  47. Fileserver
  48. Fileserver (inc MediaServer & TorrentServer)
  49. Free SSL certificates from Let's Encrypt
  50. Frequently asked questions
  51. Generating a SSH key pair from Windows
  52. Getting started
  53. GitLab
  54. Hello world
  55. Helper script: trac-initproject
  56. How to allow remote access to databases
  57. How to build a TurnKey appliance ISO from source using TKLDev
  58. How to configure LigHTTPd (aka Lighty)
  59. How to connect to Windows share from TKL
  60. How to create a jailed SFTP user (chroot jail)
  61. How to enable WebDAV on Apache
  62. How to install Oracle Java
  63. How to install VirtualBox Guest Addons & mount shared folders
  64. How to set non-US keyboard & language
  65. How to setup a Testing Environment with Proxmox on your LAN
  66. How to setup Dynamic DNS (DDNS)
  67. How to upgrade an appliance
  68. How to upgrade app XYZ in my TKL appliance [for Linux newbs]
  69. How to: Chroot into a broken system via live CD/ISO or alternate Linux system
  70. Hub/EC2 - Add new Elastic IP address (via AWS console)
  71. HubDNS - TurnKey Hub Dynamic DNS client
  72. HubTools - Python API bindings and CLI for the TurnKey Hub
  73. Import Turnkey Linux VMDK to OpenNebula
  74. Importing a previous mediawiki into TKMW
  75. Improve security of TLS/SSL connections by increasing bit size of Diffie-Hellman parameters
  76. Initihooks - System initialization, configuration and preseeding
  77. Install TKL v13.0 on Citrix XenServer 6.2
  78. Installation
  79. Installation
  80. Installation
  81. Installation (from source or via apt-get)
  82. Installing additional software via the APT package manager
  83. LigHTTPd-PHP-FastCGI
  84. Magento
  85. Manual pages
  86. Manual pages
  87. MediaWiki
  88. MediaWiki extensions
  89. MediaWiki math rendering support
  90. Migrating TurnKey Mediawiki from v14.1 to v14.2
  91. Minimum hardware requirements
  92. MySQL (inc LAMP, Drupal, Joomla etc)
  93. Networking gotcha when copying VMs installed from the ISO image
  94. New to TurnKey? Overview in links
  95. Observium
  96. Odoo 8.0 Notes with the TurnkeyLinux Odoo App
  97. OpenLDAP
  98. OpenStack
  99. OpenVPN
  100. OrangeHRM
  101. Overview
  102. ownCloud
  103. Patch development
  104. Publishing a patch
  105. Python API
  106. Redmine
  107. Redmine SVN Integration
  108. Revision Control
  109. Ruby on Rails
  110. Supported virtualization platforms and build types
  111. System monitoring and security alerts
  112. Task configuration
  113. TKLBAM hooks
  114. tklbam-backup: Backup the current system
  115. tklbam-escrow: Create a backup escrow key
  116. tklbam-init: Initialization (start here)
  117. tklbam-list: List backup records
  118. tklbam-passphrase: Change passphrase of backup encryption key
  119. tklbam-restore-rollback: Rollback last restore
  120. tklbam-restore: Restore a backup
  121. TKLBAM: Migration to v14.x from earlier versions of TurnKey Linux
  122. TKLDev - Appliance Build Engine
  123. TKLPatch - a simple appliance customization mechanism
  124. Tomcat on Apache
  125. Torrent Server
  126. Trac
  127. Trac usage: Creating and accessing projects
  128. Troubleshooting TKLBAM S3 access
  129. TurnKey Hub
  130. TurnKey Linux appliances behind a reverse proxy
  131. TurnKey Linux Backup and Migration (TKLBAM)
  132. Turnkey Linux on Proxmox Virtual Environment (aka TKL on PVE)
  133. TurnKey on Microsoft Hyper-V
  134. TurnKey server domain configuration
  135. TurnKey support
  136. Tutorials / HOWTOs
  137. UNTESTED: Update ownCloud to v8.x upstream
  138. Uploading and Launching TurnKey Linux on OpenStack
  139. Usage
  140. Usage
  141. Using default VM build with KVM
  142. Virtual Networking Explained
  143. Virtualization notes
  144. Webmin
  145. WordPress
  146. WordPress multisite support (aka. Network Sites)
Legacy documentation7 preserved guides for older systems