Staticman

Static sites with superpowers

Info for Dan!!!

This Staticman instance is used to provide comments for my blog at https://blog.danskingdom.com. You can checkout it's GitHub repo here.

I forked this repo from the official Staticman repo in order to deploy my own instance to Azure at https://dansblog-staticman.azurewebsites.net. Previously I had my own instance deployed to Heroku, which you can view the archived code for here, but when Heroku removed their free tier I moved to Azure.

To deploy to Azure, in the Azure portal I created a new Web App (App Service) on my Windows App Service Plan and granted it permissions to access this git repo. It created the GitHub action that is used to deploy the code to the Web App. Rather than enabling CI/CD, you must manually trigger the GitHub action to deploy the code to Azure.

In the Azure portal for the Web App, I added the following Application Settings:

AKISMET_API_KEY: [redacted]
AKISMET_SITE: https://blog.danskingdom.com
GITHUB_APP_ID: [redacted]
GITHUB_PRIVATE_KEY: [redacted]
NODE_ENV: production
RSA_PRIVATE_KEY: [redacted]
SCM_DO_BUILD_DURING_DEPLOYMENT: true

To get the GITHUB_APP_ID and GITHUB_PRIVATE_KEY I followed these instructions to create a GitHub App that has permissions to open pull requests on my blog repo.

I obtained the AKISMET_API_KEY and AKISMET_SITE values by creating a free Akismet account at https://akismet.com. Before using Akismet I received a ton of spam comment PRs on my blog, but after enabling it I rarely get any.

Keys and passwords stored in my blog's public config files have been encrypted using my Staticman instance's encryption endpoint, as per the Staticman encryption docs.

Initial problems after deploying to Azure and resolution

After deploying the code to Azure, I was getting a You do not have permission to view this directory or page. error message when viewing the site root https://dansblog-staticman.azurewebsites.net. This StackOverflow answer pointed me in the direction of the problem being there was no root web.config file in the site. This Azure Docs issue pointed me to the official MS docs that described the problem and mention the solution is to add the SCM_DO_BUILD_DURING_DEPLOYMENT application setting to have Azure automatically create the web.config file when the site is deployed. Afterward, I found this same solution mentioned in this StackOverflow answer.

Once the web.config was created, I ran into a new problem where the page would load for about a minute and eventually give a 500 status code message saying dansblog-staticman.azurewebsites.net is currently unable to handle this request.. Enabling diagnostic logs on my Web App in the Azure Portal showed the following error:

IIS was not able to access the web.config file for the Web site or application. This can occur if the NTFS permissions are set incorrectly. IIS was not able to process configuration for the Web site or application. The authenticated user does not have permission to use this DLL.

This error message led me to this StackOverflow answer showing that the problem was my node app was listening to the wrong port. For Azure node apps, they need to obtain the port number to listen to from the process.env.PORT variable. This required a small change to the app, which you can read about in the section below.

At this point I was now able to load the root website correctly, but posting comments still resulted in a 500 error. Looking in the application logs on the Azure portal again, I could see it was getting an error authenticating against GitHub. I had tried using the newer recommended method of creating a GitHub App to act as my Staticman bot for opening PRs by following the instructions at https://staticman.net/docs/getting-started.html, and getting the GITHUB_APP_ID and GITHUB_PRIVATE_KEY environment variables, but I kept getting an authentication error. Since I had things working on Heroku using the legacy GITHUB_TOKEN method, I decided to just stick with that instead. It did require a small change to the app though, which you can view in PR #3, as the main Staticman repo does not allow using the legacy GitHub token method with v3 endpoints.

I later found this guide which mentions how to overcome the problem I was having with using the GitHub App. The problem is that copy-pasting the GITHUB_PRIVATE_KEY RSA multi-line pem file contents into the Azure portal replaces 2 newline characters with spaces. I fixed this issue by using the Advanced Edit in the portal to replace the spaces surrounding the key value with newline \n characters (e.g. change ----BEGIN RSA PRIVATE KEY----- <value> -----END RSA PRIVATE KEY----- to ----BEGIN RSA PRIVATE KEY-----\n<value>\n-----END RSA PRIVATE KEY-----). That fixed the issue, so I reverted my PR #3 change I had made, and replaced the GITHUB_TOKEN application setting with the GITHUB_APP_ID and GITHUB_PRIVATE_KEY application settings. This also allowed me to delete the separate GitHub account I had created, which was where the GITHUB_TOKEN personal access token had originally come from.

Changes I've made since forking

Below is the list of things I changed from the original Staticman repo to make it work on Azure:

In PR #2 I updated the server.js file to use the process.env.PORT variable for the port number, rather than the PORT environment variable from the config. This is required for Azure node apps.

In addition, I also updated the default GitHub Action that the Azure portal had created for deployments:

In PR #1 I changed it to zip and unzip the artifacts being stored, reducing deployment time from 40+ minutes to about 6 minutes.

Introduction

Staticman is a Node.js application that receives user-generated content and uploads it as data files to a GitHub and/or GitLab repository. In practice, this allows you to have dynamic content (e.g. blog post comments) as part of a fully static website, as long as your site automatically deploys on every push to GitHub and/or GitLab, as seen on GitHub Pages, GitLab Pages, Netlify and others.

It consists of a small web service that handles the POST requests from your forms, runs various forms of validation and manipulation defined by you and finally pushes them to your repository as data files. You can choose to enable moderation, which means files will be pushed to a separate branch and a pull request will be created for your approval, or disable it completely, meaning that files will be pushed to the main branch automatically.

You can download and run the Staticman API on your own infrastructure. The easiest way to get a personal Staticman API instance up and running is to use the free tier of Heroku. If deploying to Heroku you can simply click the button below and enter your config variables directly into Heroku as environment variables.

Requirements

Node.js 8.11.3+
npm
A personal access token for the GitHub and/or GitLab account you want to run Staticman with
An RSA key in PEM format

Setting up the server on your own infrastructure

NOTE: The below steps are not required if deploying to Heroku. To deploy to Heroku, click the above deploy button and enter your configuration variables in the Heroku Dashboard.

Clone the repository and install the dependencies via npm.

git clone git@github.com:eduardoboucas/staticman.git
cd staticman
npm install

Create a development config file from the sample file.
```
cp config.sample.json config.development.json
```
Edit the newly-created config file with your GitHub and/or GitLab access token, SSH private key and the port to run the server. Click here for the list of available configuration parameters.
Start the server.
```
npm start
```

Each environment, determined by the NODE_ENV environment variable, requires its own configuration file. When you're ready to push your Staticman API live, create a config.production.json file before deploying.

Check this guide if you're using Docker.

Setting up a repository

Staticman runs as a bot using a GitHub and/or GitLab account, as opposed to accessing your account using the traditional OAuth flow. This means that you can give it access to just the repositories you're planning on using it on, instead of exposing all your repositories.

To add Staticman to a repository, you need to add the bot as a collaborator with write access to the repository and ask the bot to accept the invite by firing a GET request to this URL:

http://your-staticman-url/v2/connect/GITHUB-USERNAME/GITHUB-REPOSITORY

Site configuration

Staticman will look for a config file. For the deprecated v1 endpoints, this is a _config.yml with a staticman property inside; for v2 endpoints, Staticman looks for a staticman.yml file at the root of the repository.

For a list of available configuration parameters, please refer to the documentation page.

Development

Would you like to contribute to Staticman? That's great! Here's how:

Read the contributing guidelines
Pull the repository and start hacking
Make sure tests are passing by running npm test
Send a pull request and celebrate

deadlydog/deadlydog.github.io-staticman