Tag Archives: Git

Deploying a Bookdown site securely⤴

from @ @cullaloe | Tech, tales and imagery

I have been writing documentation for a project in markdown using RStudio, which provides a nice way of packaging it all as a static (html) website. I wanted to share this work with colleagues securely.

Writing workflow

The documents exist within an RStudio project and are built to a folder containing static files. That folder is by default _book, but I change this to docs to make it easy to deploy as a github site if I wish1. Configuration management is a crucial element to proper productivity, not just in software but also in all walks of life where documentation is important. Because of this, I use github to store my work safely, should I lose a laptop or suffer some other first-world calamity. It’s one of the reasons I use markdown when writing: configuration management is well-suited to text-based documents because it is easy to track and manage changes.

Although I keep the source files on github, I haven’t published this project to github pages because it should not be publicly available: instead, I deploy to a VPS (Centos/Apache/Plesk), putting it all behind a login.

The domain

I set up a specific domain static.cullaloe.net for this project, and secured it with an SSL certificate.

The files

Clone the GitHub repository into a new folder somewhere behind the web-facing directory (i.e. not in httpdocs). In this example, both the repository and the local folder are called “foobar”:

$ git clone https://github.com/githubuser/foobar.git /var/www/vhosts/[domain]

It is not necessary to specify the target directory, you’ll get that as default. It is not possible2 to selectively clone a github project: it’s all or nothing. /var/www/vhosts/[domain]/foobar now contains all of the source files of the project.

Permissions

You need to create a .htpasswd file in the server somewhere, containing the username and password you wish to grant access to your files to:

$ /path/to/htpasswd -c /var/www/vhosts/[domain]/.htaccess user1

This prompts you for the password you wish to set for this user. Adding another user is the same command without the -c option.

The server

You need to tell the Apache, using Alias, where to find the files, and with <Location>, control who can access files at the URL you are trying to protect. In the Plesk control panel, Apache & nginx Settings for static.cullaloe.net ···:

Alias /foobar /var/www/vhosts/[domain]/foobar/docs
<Location /foobar>
	AuthType Basic
	AuthName "Restricted access"
	AuthUserFile /var/www/vhosts/[domain]/.htpasswd
	Require user user1
</Location>

Outcome

I can easily continue to work on my project documentation, updating it from time to time for colleagues who are interested in seeing what I’m doing. I make (neurotic) use of github for configuration management and safekeeping of all my hard work anyway, so updating the site just requires $ git pull from the repository folder on the web server. They can then view the documentation in a browser, or download a pdf or docx that is up-to-date with my current progress.

Notes

  1. In bookdown.yml, add the line output_dir: "docs"

  2. As far as I know, anyway. 

Pushing and Pulling the Twitter Archive⤴

from @ John's World Wide Wall Display

a-bird-in-the-hand

There are probably 2 folk who have a slight interest in this rather geeky post. It does not have much to do with ICT in the classroom.

I’ve been using Martin Hawksey‘s twitter archiver for a while now. This archived my tweets to Google Drive and made them available online.

The other day I saw Martin tweet a change. Google Drive will drop the ability to serve webpages soon so Martin has updated the setup to use GitHub. He also took the time to make the setup a lot more user friendly (if you have a github account and a very little experience with git).

The set up involves downloading your twitter archive from twitter. You then set up your GitHub Pages – Website. To this you push your downloaded archive, connect to Martin’s script and away you go. The local git stuff is just used to kick off the pages site, which then is updated from the script. It works a treat: My Twitter archive. I am not trying to replicate the instructions here, the set up page has that covered.

What I did wonder was if you could pull the updates back down locally. Sort of PESOS, but to my hard drive rather than own site. I guess it could go truly PESOS if I knew how to push it out to johnjohnston.info (thinks, maybe I do 1).

This is how I pull the github stuff back down to my hard driver.

A very simple shell script:

cd /Users/john/Sites/troutcolor.github.io/;git pull > /Users/john/Desktop/loga.txt

saved in a file and the file made executable, (the loga.txt file was just for testing).

A launchd 2 configuration file, made with Lingon runs the script every day.

Featured Image: A Bird in the Hand by Julie Falk used under a CC-BY-NC license.

1. As I wrote this I realise that git-ftp could do this. After configuring it in my local folder I added git ftp push to the script. This will push to my website, so My Twitter archive on johnjohnston.info.

2. launchd seem to be thing to use instead of cron to run things periodically on a mac. Lingon simplifies creating and handling them. I’m using the old 2x version of Lingon, it seems to work.