Skip to content
The homepage for Free Law Project
CSS HTML JavaScript Makefile Python Shell
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.idea
content
themes/pelican-bootstrap3
.gitignore
.travis.yml
Makefile
README.md
develop_server.sh
example.md
fabfile.py
pelicanconf.py
publishconf.py
requirements.txt

README.md

Free Law Project Website

This is the website for Free Law Project. Like the rest of our work, it is developed in the open and can be edited by other people, like you. See a typo? Fix it! Want to make the site look better? Go for it!

This site uses the Pelican static site generator, which means that there is no database, no dynamic code on the site, aside from what JavaScript can do in your browser. The entire site is here -- in Github -- and you can render it yourself, work on it locally, and even host it on your own server if you wanted to (though we'd send our shark lawyers after you).

Installation

If you want to work on the site, the thing to do is install the dependencies. All of them are Python dependencies, so if you have Python installed, you can probably do this pretty quickly.

  1. Optional but recommended: Make a virtualenv and activate it.

    If you don't know how to do this or why you'd want to, it's something that you'll want to learn eventually, but you can probably skip this step if you just want to get to blogging. Skipping this step may cause problems, but probably won't. If you want to learn more about virtualenv and its virtues, it's a pretty quick read. I also recommend virtualenvwrapper, which makes virtualenv easier to use. It's not essential though.

  2. Download this repository:

    If you don't have Git, install it, then run:

     git clone https://github.com/freelawproject/free.law.git
    
  3. Install the requirements file:

    If you're using virtualenv, make sure it's activated, then:

     cd free.law
     pip install -r requirements.txt
    
  4. Install the pelican-plugins in a directory next to your current directory.

     cd ..
     git clone https://github.com/getpelican/pelican-plugins.git
    

    You will now have all the dependencies installed.

  5. Most people can skip this step, but if you're somebody that has permission to push the content to Amazon, configure the two Amazon tools by running:

     s3cmd --configure
    

    This will ask for your Access Key and Secret key, which are at this link.

    Configure the second tool with:

     aws configure
    

    Tell it your access and secret keys as well, and leave the region and output format blank. Then enable preview features by running:

     aws configure set preview.cloudfront true
    

You're done!

Writing a post or a page

Posts are easy to write, but to make it even easier, there's a template called example.md. Make a copy of that file with a descriptive name and put it in the content directory. Write your post in markdown in that file and generate the HTML when you think your post is ready (read on for how to do that).

If you want to tag your post, unfortunately, we don't have autocomplete for that. So either just go for it, and we can embrace a folksonomy or look in the output/tag directory, where all the existing tags are listed.

If you're making a page, it's just like making a post, except you put it in the content/pages directory instead. You can also give it a custom slug if you want (you probably should), so that it shows up at /contact/ instead of /pages/contact/, for example.

Finally, it should go without saying, but if you see something on the site that you want to replicate, just search through this repository for words in the post and you'll find the markdown file that made that page. Replicate away!

Generating HTML Content from Markdown Files

If you want to see your work, activate your virtualenv if you're using one, then run a command like:

pelican content -s pelicanconf.py -d -r

This will use the development settings (-s pelicanconf.py) to delete the output directory before recreating it (-d), and will automatically regenerate the content whenever it changes (-r).

Once the generation is done, the content is in the output directory. If you're writing a draft, it will be in the output/drafts folder.

Feel free to look at the other options the pelican command provides.

Running a development server

To see the content in Firefox or Chrome or whatever, activate your virtualenv if you're using one, change into the output directory, then run:

python -m pelican.server

That will run a little server on your laptop, and with it running you can go to http://localhost:8000, where you'll find you have a server running on port 8000.

Tweaking the default theme

All of its code is in the themes directory. Go for it.

Pushing content to Amazon (Publishing Your Work)

To publish your post, simply run:

make s3_upload

This will regenerate the site using the publishconf.py file, then will sync it with Amazon, pushing anything new and deleting anything old.

Note that if you're updating an item, you may have to wait for cache invalidation to occur before you'll see your changes. The cache is cleared automatically when you run s3_upload, but it can take a few minutes (sometimes up to ten) for the cache to clear everywhere.

Infrastructure

There are a lot of pieces in this puzzle, so this is where they are documented. The set up that we have was inspired greatly by the post here.

Requests to the naked domain do this:

Route 53 (DNS) --> CloudFront Distribution --> S3 Bucket (free.law)

Requests to the www subdomain (hopefully a corner case) do this:

Route 53 (DNS) --> CloudFront WWW Distribution -->
S3 Bucket (www.free.law) --> Redirects to naked domain --> Route 53 -->
CloudFront Distribution (Redirects HTTP to HTTPS) --> S3 Bucket (free.law)

This means that there are essentially two parallel set ups for DNS (Route 53), Content Distribution (CloudFront) and File Serving (S3). Redirections from HTTP to HTTPS are configured in CloudFront. Redirections from www happen in an empty S3 bucket specifically for this purpose.

SSL is configured in Amazon Certificate Manager (ACM), which will handle auto-renewals and hopefully everything else.

All in all, this is a pretty killer set up. Most clients will get served by CloudFront and it will be incredibly fast. Clients that go to http://www.free.law will suffer three redirections:

Life is hard for these people.

There is another weak point in this configuration. The connection between CloudFront and S3 is not encrypted. Pretty lame, but the reason for this is that you have to use the Static Site URL as the Origin that feeds into CloudFront, and that URL doesn't support SSL even though the S3 URLs do.

You can’t perform that action at this time.