doc/tips/github.mdwn

   1 [[!meta date="2008-12-29 14:58:54 -0500"]]
   2
   3 Here's how to set up a static wiki or blog using ikiwiki with no hosting
   4 fees. Everything is hosted on github, both the git repository and the web
   5 site. Your laptop is used to generate and publish changes to it.
   6
   7 This is possible because github now supports
   8 [github pages](http://github.com/blog/272-github-pages).
   9
  10 Note that github limits free accounts to 100 MB of git storage. It's
  11 unlikely that a small wiki or blog will outgrow this, but we are keeping
  12 two copies of the website in git (source and the compiled site), and all
  13 historical versions too. So it could happen. If it does, you can pay github
  14 for more space, or you can migrate your site elsewhere.
  15
  16 ## Github Setup
  17
  18 * Go to [github](http://github.com/) and sign up for an account, if you haven't already.
  19 * Be sure to add your laptop's ssh key to it so you can push to github.
  20 * Create a repository on github named `$YOU.github.com`, substituting your
  21   *username*. This repository will be used to publish your compiled website.
  22 * Create a repository on github named `$YOU` (or anything else you like).
  23   This repository will be used to publish the source of your website.
  24   This is actually optional.
  25
  26 ## Local Setup
  27
  28 * On your laptop, create two empty git repositories to correspond to the github repositories: <br />
  29         `YOU=your github username here` <br />
  30         `mkdir ~/$YOU.github.com` <br />
  31         `cd ~/$YOU.github.com` <br />
  32         `git init` <br />
  33         `git remote add origin git@github.com:$YOU/$YOU.github.com.git` <br />
  34         `mkdir ~/$YOU` <br />
  35         `cd ~/$YOU` <br />
  36         `git init` <br />
  37         `git remote add origin git@github.com:$YOU/$YOU.git` <br />
  38 * Add some wiki pages, such as an `index.mdwn`, to `~/$YOU`, and check them
  39   in and commit them to git. You need something to push to github. Run
  40   `git push origin master` to push the source pages to github.
  41
  42 ## Publishing to Github
  43
  44 * Now build your wiki with a command such as: <br />
  45         `ikiwiki ~/$YOU ~/$YOU.github.com --refresh`
  46 * Each time you build the wiki you will need to commit the changes
  47   to git, and push the compiled pages to github: <br />
  48         `cd ~/YOU.github.com` <br />
  49         `git add .` <br />
  50         `git commit -a -m update` <br />
  51         `git push origin master` <br />
  52
  53 Your wiki will show up at `http://$YOU.github.com/` within ten
  54 minutes after the first push, and changes you push to it from then on
  55 should show up immediately.
  56
  57 ## Enhancements
  58
  59 You can follow the instructions in [[laptop_wiki_with_git]] to set up an
  60 editable version of your wiki on your laptop. Then you can use the web
  61 interface for editing. You'll still need to follow the instructions above
  62 to publish your changes to github.
  63
  64 It would also be possible to teach ikiwiki to push compiled pages to github
  65 itself via a plugin, as was done with the [[plugins/amazon_s3]] plugin. Not
  66 done yet!