Direct File Hosting - A Simple Guide

Posted by rs picture rs on Mon 12 Oct, 2009 13:57:46 +0000

Direct File Hosting (DFH) is XP-Dev.com’s web hosting solution to publish web sites directly from your XP-Dev.com Subversion repository. It publishes static web sites with the help of Jekyll

I’ve mentioned it previously in older blog posts.

It’s not a new feature on XP-Dev.com per se. So far, close to 1000 repositories on XP-Dev.com have the feature turned on, however, due to the release of the new platform, I doubt many of the repositories are actually using all the new features.

Features

So, lets take a quick recap on what DFH actually is: You have a repository with some content (presumably its your website in there). DFH will take your repository and export the contents so that it can be hosted on a public web server under a sub-domain in the form of repository-name.svn-node.xpdev-hosted.com. The idea is to have the whole website under revision control (including images, non-HTML files, etc).

Couple of new features worth mentioning:

  • Support for Jekyll - Jekyll is a blog aware, static site generator written in Ruby. DFH processes repository contents via Jekyll so that it can perform its magic and generate a static web site. Head over to the project’s home page to find out more about Jekyll. As long as your repository contents work fine with Jekyll running locally on your development machine, it should just work out-of-the-box here at XP-Dev.com.
  • Mapping Domains - DFH by default assigns a sub-domain of xpdev-hosted.com, but that’s not fun, let alone nice. Wouldn’t it be nice if you could just host the site using your own domain ? Well, you can! All you have to do is ensure that add your domain (or subdomain) into the repository configureation and ensure that it is mapped to the correct IP address in your DNS settings. Leave the rest to DFH to handle.

In case you’re wondering whether DFH is vulnerable to the ‘.svn’ hack, rest assured, it is not vulnerable. DFH uses the export command to checkout content from your repositories.

Documentation

Some initial documentation has been added to the documentation site. It should help you get started with configuring DFH for your repository:

http://docs.xp-dev.com/user-guide/directfilehosting.html

Example Website

Do have a look at XP-Dev.com’s documentation website at http://docs.xp-dev.com as an example. It is hosted using DFH with Jekyll and the domain mapped for docs.xp-dev.com.

The documentation project wiki home page is: http://www.xp-dev.com/wiki/51832/Homepage

Additionally, you can browse the web site source files that Jekyll processes to generate the website as well: http://www.xp-dev.com/sc/browse/51832/

Development Environment

I thought it might be worth mentioning my local development environment for updating the documentation website above. I have the whole website as a project in Eclipse with Mylyn’s WikiText plugin installed to render the Textile pages (*.textile files).

What I end up with is a Textile editor with syntax highlighting and if I do need to add any HTML files, there’s always Eclipse’s Web Tools to help out.

For those that are not so inclined to go down the IDE route, most text editors have support for Textile formatting in some form.

Feedback is always welcome and if you do have a different development environment, feel free to share it in the comments below!

View 0 comments

Comments

Entry has no comments

You do not have sufficient permissions to comment

Blog Entry Options

Blog Options

Blog Archives

Feeds

Blog Entry and Comments