文件列表:

.merlin (191, 2016-04-26)
.travis.yml (157, 2016-04-26)
Dockerfile (889, 2016-04-26)
assets/ (0, 2016-04-26)
assets/assets_generated.tar.gz (1319936, 2016-04-26)
assets/fonts/ (0, 2016-04-26)
assets/fonts/JosefinSans-SemiBold.ttf (97264, 2016-04-26)
assets/fonts/OFL.txt (4447, 2016-04-26)
assets/js/ (0, 2016-04-26)
assets/js/main.js (154, 2016-04-26)
assets/less/ (0, 2016-04-26)
assets/less/partials/ (0, 2016-04-26)
assets/less/partials/atoms.less (391, 2016-04-26)
assets/less/partials/constants.less (359, 2016-04-26)
assets/less/partials/layout.less (274, 2016-04-26)
assets/less/partials/navbar.less (4347, 2016-04-26)
assets/less/partials/reset.less (153, 2016-04-26)
assets/less/partials/typography.less (804, 2016-04-26)
assets/less/style.less (557, 2016-04-26)
canopy_article.ml (2973, 2016-04-26)
canopy_config.ml (366, 2016-04-26)
canopy_content.ml (1615, 2016-04-26)
canopy_dispatch.ml (5419, 2016-04-26)
canopy_main.ml (3831, 2016-04-26)
canopy_store.ml (5507, 2016-04-26)
canopy_syndic.ml (974, 2016-04-26)
canopy_templates.ml (2721, 2016-04-26)
canopy_utils.ml (1464, 2016-04-26)
config.ml (4561, 2016-04-26)
inflator.ml (2120, 2016-04-26)
package.json (748, 2016-04-26)
tls/ (0, 2016-04-26)

# Canopy - A git-blogging unikernel [](https://travis-ci.org/Engil/Canopy) Canopy is an attempt at writting a blog-engine based on Git using [MirageOS][mirage]. The goal is to provide a simple blog platform that only requires you to provide a Git remote URL and respecting some architecture rules within the said repository. Canopy is written in OCaml using MirageOS and [Irmin][irmin]. It is running on both Unix and Xen. [decompress]: [mirage]: [irmin]: ### HTTPS/TLS support Canopy has TLS support, you have to first create your TLS private key and get a signed certificate (using [certify](https://github.com/yomimono/ocaml-certify) and/or [let's encrypt](https://letsencrypt.org/) - sorry, no let's encrypt client in OCaml yet). Put your unencrypted private key into `tls/server.key`, and your full certificate chain (starting with the server certificate, then the intermediate CAs, no need to include the root CA) into `tls/server.pem` before running `mirage configure` (which will embed them as OCaml code into the binary). You can configure Canopy with `--tls=` (or `-t `) to run it as HTTPS service. Canopy will then respond to HTTP requests with a [moved permanently](https://tools.ietf.org/html/rfc2616#section-10.3.2) redirection to the HTTPS URL. Also, the HTTPS service includes a [strict transport security](https://en.wikipedia.org/wiki/HTTP_Strict_Transport_Security) HTTP header (containing `max-age=31536000; includeSubDomains`). ### Compiling and running Canopy You will need at least `OCaml 4.02.3`, `opam 1.2` and `mirage 2.7.0` before starting. To setup a mirage environment, please refer to the mirage website. You'll also need `npm`, `less-css` and `browserify` if you want to compile and retrieve everything related to the blog-styling. The `mirage configure` step takes care of fetching and recompiling all assets. If none of the mentionned programs were to be found, the configure step will use the tarball found in the `assets` directory, containing already compiled assets. Checkout Canopy repository, then go inside: ```sh # You need syndic using ptime, thus first install ptime opam install ptime # Then pin syndic to the branch where ptime is used opam pin add syndic https://github.com/Cumulus/syndic.git#ptime # Configure the mirage application, compile assets mirage configure --unix # Compile Canopy make # Run it ./mir-canopy -r https://github.com/Engil/Canopy-documentation.git -i Welcome -p 8080 ``` A server will be launched using the specified URL as the git remote, `Index` as the default page rendered on the blog (it must exist within the repository) and `8080` is the listening port. You can see more options by running `./mir-canopy --help`. ### Compiling and running on Xen If you want to build for xen, there's a couple of packages that need to be installed from specific branches. ```sh opam pin add dolog 'https://github.com/UnixJunkie/dolog.git#no_unix' opam pin add bin_prot 'https://github.com/hannesm/bin_prot.git#113.33.00+xen' ``` You can either build with support for DHCP or static ip, just specifying it as command line arguments, for instance: ```sh mirage configure --xen --dhcp false --net direct --ip 10.0.0.2 --netmask 255.255.255.0 --gateways 10.0.0.1 make ``` Make sure to have `br0` set up for this. For example, I did: ```sh # provide ip forwarding echo 'net.ipv4.ip_forward=1' >> /etc/sysctl.conf sysctl -p /etc/sysctl.conf iptables -t nat -A POSTROUTING -o wlan0 -j MASQUERADE # create a new bridge brctl addbr br0 ip addr dev br0 add 10.0.0.1/24 ip link set br0 up ``` Finally you can run your unikernel! ```sh xl create -c canopy.xl ``` ### Git push hooks To keep your Canopy content updated, you need to tell your instance that new content is available on the git remote, then it will just pull the changes and will serve the new content. To do that, Canopy use a simple URL path that you can set into Canopy_config.ml (`hook_push_path`). Using Github, setting up this hook is pretty simple: just add a push webhook targeting your URL + your hook path. For example, by default this hook path is `push`, so the resulting URL is `http://yourdomain/push`. If you are not using Github, you can just find a way (`post-commit-hooks`, for example) to run a HTTP request to this URL. ### How Canopy works Canopy will require you to provide a Git remote uri. Once started, it will clone in-memory the repository content and serve the content in a more or less organized way. Each file at the root of the repository is considered a standalone page, more like the usual About or Contact pages. They will have their own entries in the navigation menu. Each directories will contains more pages, but that will be classified under a category decided by the name of the said directory. For example, a `posts/hello-word.md` file will be a new blog post under the `Posts` category. You can use it to emulate some sort of tag, like for example having an `OCaml` directory regrouping all you writing in everyone's favorite language. :-) The file syntax is just plain markdown, everything should be supported out-the-box (depending on the `ocaml-cow` markdown implementation), with a little bit of extra informations absolutely needed at the top of each files. ``` --- title: A blog entry author: Me abstract: A simple line telling what this article is all about, will be displayed in listing pages. (optional) --- article content ``` If you don't respect this syntax, then the article won't show up in the resulting website. You can also put some MathJax inside articles, Mathjax is activated if you pass the --mathjax parameter at startup.

近期下载者：

相关文件：

评论：[我要评论] [举报此文件]

收藏者：