Deploy and host your documentation site
The Tech Docs Template is built on Middleman, which is a static site generator. You can therefore deploy your site anywhere that supports static sites.
Use the GOV.UK PaaS
We recommend that government services use the GOV.UK PaaS to deploy documentation sites built with the Tech Docs Template. This is also free of charge for government services.
We also cannot guarantee that all features of the template will work if you deploy your site with GitHub Pages.
The Ministry of Justice cloud platform documentation uses GitHub Pages.
The GOV.UK PaaS documentation explains how to set up continuous integration (CI) with Travis and Jenkins. We recommend this method for documentation sites built using the Tech Docs Template.
Add basic authentication
There are many ways to add basic authentication to your documentation site.
The following instructions apply if you want to deploy your documentation site on the GOV.UK PaaS or another platform using the Cloud Foundry open source cloud application platform.
This method relies on adding a
Staticfile.auth file to the
build folder because building the documentation doesn’t automatically add the
Staticfile.auth file. If you added
Staticfile.auth once and run the build command again, the file will disappear. You need to add
Staticfile.auth again to enable basic authentication for the new build.
In the command line, navigate to your local documentation repo.
If required, run
bundle exec middleman buildto create a
Create a new
Staticfile.authfile in the
Go to the Htpasswd Generator.
Complete the Username and Password fields, and select Create .htpasswd file.
Copy the generated username and password hash into the
Staticfile.authfile and save.
Deploy your documentation site in line with your normal process.