gioku

Git based static page deploy system like github pages/heroku. Based on nginx and gitolite.

Installation

Right now installation is only officially supported on Ubuntu. If you want to setup manually, go take a look at scripts/basesetup.sh ans scripts/install-prod.sh.

Really most of the repository is these two files as gioku is really nothing much fancier than a post-receive hook and some simple setup steps.

But yeah.. to install on Ubuntu

First you need to get your public key for pushing to git. Save that on the target server somewhere.

Then, in your server:

$ git clone https://github.com/shuhaowu/gioku.git
$ sudo gioku/scripts/install-prod.sh

You should get a prompt for the full path of your key, try to get it right the first time as the bash script is not very good at running the second time.

It will also prompt for a domain name. Give the domain name in the form of yourdomain.com. All of the sites you create will be served as subdomains of this domain. You can also use custom domains for each website. More on that later.

Now you should go ahead and point yourdomain.com to this server. You should also setup a wildcard entry for all the subdomains and point it to the server as well.

Use

You can use gitolite-admin to manage websites. Create a new gitolite repository and that will become a website accessible under reponame.yourdomain.com

For example, you can add a site called "mrrowl" with the following appended to gitolite.conf:

repo mrrowl
  RW+ = @all

Commit that and push the gitolite admin repo (again, see gitolite's docs for more details).

Now clone the mrrowl repository

$ git clone [email protected]:mrrowl.git

Make some changes

$ cd mrrowl
$ echo "<h1>It's a mrrowl!</h1>" > index.html

Commit and push:

$ git add .
$ git commit
$ git push
Counting objects: 5, done.
Writing objects: 100% (3/3), 252 bytes, done.
Total 3 (delta 0), reused 0 (delta 0)
remote: Pushing changes to production...
remote: Pushed 81465048f05aa87666521ea82cfa18a1be0d8e4e to production!
To git@yourdomain:mrrowl.git
   6b74cc3..8146504  master -> master

Now browse to http://mrrowl.yourdomain.com to see your new site!

Let's say now you want to specify a custom domain for your website, you can do so by specifying a file called CNAME with one line. Just like Github pages.

$ echo -n "mrrowl.io" > CNAME
$ git add .
$ git commit
$ git push origin master

Go to your DNS provider and point mrrowl.io to the server.

Now you can go to http://mrrowl.io and get the same as if you were coming from mrrowl.github.io.

Certificates

You should get SSL for your website. A StartSSL certificate is free!

To use SSL certificates with gioku you must supply a CNAME!

Add a directory called _certs in your root directory for the repo.

In it, you need two files:

• cert.pem: The certificate file with all the chaining
• cert.key: The private key file.

Now, git commit and git push.

Browse to https://yourcname.com to check it out! If you go to http://yourcname.com you will be 301 redirected to the https version!

Here's the security setting generated by gioku for those who are concerned:

ssl_prefer_server_ciphers on;
ssl_protocols TLSv1 TLSv1.1 TLSv1.2;
# forward secrecy
ssl_ciphers ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-RC4-SHA:ECDHE-RSA-AES128-SHA:AES128-GCM-SHA256:RC4:HIGH:!MD5:!aNULL:!EDH:!CAMELLIA:!PSK:!SRP;
ssl_session_cache    shared:SSL:10m;
ssl_session_timeout  10m;
add_header Strict-Transport-Security max-age=31536000;

Please note that project.giokuhost.tld is still available under non SSL.

Some more logistics

In your repositories:

• index.html is mapped as the index.
• /404.html will be displayed in event of 404.
• /403.html for 403.
• /CNAME is a file with one line that specifies a custom domain for that repo
• /_certs/cert.pem is the certificate file (public)
• /_certs/cert.key is the private key file