Note: GitLab Pages now fully integrate with Let’s Encrypt, making this post obsolete.
This post describes a recipe for setting up a static website for free with these features:
- Custom domains
- SSL with Let’s Encrypt
- Version control using Git, hosted by gitlab.com or your own GitLab instance
- Jekyll or other static site generators supported by GitLab Pages
- Install Jekyll
- Fork GitLab’s template Jekyll repository, or create your own locally
- Point DNS records to GitLab
Your site should be accessible through your custom domain using plain HTTP at this point.
To make this part easier, I’ve written a command-line tool named gitlab-le which handles obtaining and renewing HTTPS certificates from Let’s Encrypt.
Install gitlab-le with
npm install --global gitlab-letsencrypt (requires Node.js 8 or greater).
Test everything works OK with the following command. See instructions for getting a GitLab access token.
If everything worked, re-run the same command with an additional
At this point, your website should be accessible via HTTPS. Yay! However, the certificate we’ve obtained will only last for 90 days, so we need some way of renewing it.
Renewing HTTPS certificate
To renew your HTTPS certificate, run gitlab-le again with the same options, including the
Automating this to run every 90 days is left as an exercise for the reader.
Tip: You can run gitlab-le run without the
--productionoption as often as you want without fear of being rate-limited by Let’s Encrypt. This allows you to detect and fix issues with your repository before the certificate expiration date.
If you don’t want to or can’t set this up to run automatically, Let’s Encrypt will send notices when your certificate is about to expire to the
Currently it is not possible to automatically redirect all visitors to the HTTPS version of your website. There is an open issue on the GitLab CE repository to track this feature.
Netlify’s free plan offers these same features with a friendly UI, but it is a closed-source service.