Skip to content
This repository has been archived by the owner on Jun 23, 2023. It is now read-only.

Commit

Permalink
Added mentions to raw.githack.com to README.md
Browse files Browse the repository at this point in the history
Fixed most of my derpo spelling in README.md

Signed-off-by: Shane Gadsby <schme16@gmail.com>
  • Loading branch information
schme16 committed May 10, 2015
1 parent c182b43 commit 99dc352
Showing 1 changed file with 16 additions and 13 deletions.
29 changes: 16 additions & 13 deletions README.md
@@ -1,5 +1,6 @@
# GitCDN
A CDN for raw.githubusercontent.com content, that always links to the latest version (aka your master branch)
A CDN for raw.githubusercontent.com content, that always links to the latest version (aka your master branch).
Built on NodeJS for rock solid delivery!

##Build Status
[![wercker status](https://app.wercker.com/status/3bd39472bd17b07fe55170316d6a8fbf/m "wercker status")](https://app.wercker.com/project/bykey/3bd39472bd17b07fe55170316d6a8fbf)
Expand All @@ -16,7 +17,7 @@ A CDN for raw.githubusercontent.com content, that always links to the latest ver

##How much does GitCDN cost?
GitCDN is TOTALLY FREE!
That's not to say I won't have plans that have a monthly/yearly price in the future, but the repo CDN service will ALWAYS be free, without the need for signup!
That's not to say I won't have plans that have a monthly/yearly price in the future, but the repo CDN service will ALWAYS be free, without the need for sign-up!


##Want to buy me a coffee?
Expand All @@ -36,42 +37,44 @@ See point #2 in the [How to use](#how-to-use) section above. But basically you j

##Can I manually flush the cache?
No.
Whilest theoretically an API could be added to allow you to request a cache flush of your item, the current implimentation of cacheing via a redirect page that only caches for ~2 hours makes the nessecity of this lower, but the server load exponentially higher. Feel free to still [submit it as a feature request/pull request](https://github.com/schme16/gitcdn.xyz/issues/new)
Whilst theoretically an API could be added to allow you to request a cache flush of your item, the current implementation of caching via a redirect page that only caches for ~2 hours makes the necessity of this lower, but the server load exponentially higher. Feel free to still [submit it as a feature request/pull request](https://github.com/schme16/gitcdn.xyz/issues/new)


##How is this Different from [RawGit.com](https://rawgit.com)
The main difference is our focus on providing the **latest** commit of a given GitHub file, where as RawGit has more of a focus on providing **specific commits**.
##How is this Different from [RawGit.com](https://rawgit.com) and [githack.com](https://raw.githack.com/)
The main difference, is our focus on providing the **latest** commit of a given GitHub file, where as RawGit has more of a focus on providing **specific commits** and githack with efficient serving (they use nginx).
Each of the services mentioned above are awesome, and I'd like to thank the developers behind each for creating such brilliant services; but both are built with a bit of a glass jaw, that is, that users can either *accidentally*, or worse, **deliberately** cripple their services just through normal usage. My aim was to build GitCDN with a focus on preventing that being available to end users, and we achieve this through clever tweaks on Cloudflare that mean that a most a file will be hard accessed (accessed without a cache copy, directly from my servers) once per region/2hrs.

Another major difference between GitCDN and RawGit, is what CDN providers I use:
- GitCDN uses [Cloudflare](https://cloudflare.com).
- RawGit uses [MaxCDN](https://maxcdn.com).

Lastly, GitCDN and RawGit have a slightly different setup for development and cdn versions.
RawGit provides a live version of your file (`https://rawgit.com/`) that updates in real-time (whis is only useful when using your master branch) and a CDN version (`//cdn.rawgit.com`); GitCDN on the other hand, caches every request made to `https://gitcdn.xyz/repo/` for a breif period (~2 hours), this means that any change made can take up to 2 hours to propagate through to all users, but means you don't have to worry about leaving a dev link in your production environment and accidentally overwhelming our service, see: https://rawgit.com/faq#rawgit-com-in-production for why I chose this route.
RawGit provides a live version of your file (`https://rawgit.com/`) that updates in real-time (which is only useful when using your master branch) and a CDN version (`//cdn.rawgit.com`); GitCDN on the other hand, caches every request made to `https://gitcdn.xyz/repo/` for a breif period (~2 hours), this means that any change made can take up to 2 hours to propagate through to all users, but means you don't have to worry about leaving a dev link in your production environment and accidentally overwhelming our service, see: https://rawgit.com/faq#rawgit-com-in-production for why I chose this route.

The advantage of these differences is that, while not providing promises about uptime, this setup is less likely to be impacted my large user volumes (as every item is cached for a minimum or ~2hrs) so feel free to use this in a high volume environment (not that I'm telling you to go and use it in production, but just that if you do it won't harm me in the same way that RawGit and githack would be).

It should be noted that Cloudflare, strickly speaking, is not a CDN, and that its original focus was on network security/attack mitigation, the side effect of this is that they cache files much like a traditional CDN.

**Sidenote:** I've been using Cloudflare for a several years and have been more than happy with their service, but for a broader opinion you can see a pretty good write-up by [Kevin Muldoon](http://www.kevinmuldoon.com/), [Cloudflare vs MaxCDN](http://winningwp.com/cloudflare-vs-maxcdn/), which covers each oif their strengths pretty nicely, and for more details about RawGit please see their [FAQ](https://rawgit.com/faq)
**Sidenote:** Cloudflare, strictly speaking, is not a CDN, and that its original focus was on network security/attack mitigation, the side effect of this is that they cache files much like a traditional CDN.
I've been using Cloudflare for a several years and have been more than happy with their service, but for a broader opinion you can see a pretty good write-up by [Kevin Muldoon](http://www.kevinmuldoon.com/), [Cloudflare vs MaxCDN](http://winningwp.com/cloudflare-vs-maxcdn/), which covers each of their strengths pretty nicely, and for more details about RawGit please see their [FAQ](https://rawgit.com/faq)


##Does this mean I can host a website straight from GitHub?
Almost, you can certainly host all of your files here, then link them in the index of your website!


##Plans for the future
- Better (Re: any) website frontpage; I love how easy RawGit made their url helper, so I will be including something similar ASAP!
- My goal is to add the ability to host your static website directly from your GitHub repo, with CNAME support for custom domains. There's no timeline for completion, but I'm super keen to make it happen (For free, of course).
- There are also still plenty of optimizations to do; but this service is definitly ready for production.
- Better (Re: any) website front-page; I love how easy RawGit made their URL helper, so I will be including something similar ASAP!
- My goal is to add the ability to host your static website directly from your GitHub repo, with CNAME support for custom domains. There's no time-line for completion, but I'm super keen to make it happen (For free, of course).
- There are also still plenty of optimizations to do; but this service is definitely ready for production.


##Have an issue, idea or feedback?
Great! We love hearing from you, just visit [https://github.com/schme16/gitcdn.xyz/issues/new](https://github.com/schme16/gitcdn.xyz/issues/new) and submit your great idea/annoying bug/awesome feedback!


##Acknowledgements & Background
##Acknowledgments & Background
The inspiration for this whole project comes from [RawGit](https://rawgit.com/) from [Ryan Grove](http://wonko.com/)
I absolutly love the service that Ryan has made available, and have used it for quite a while with great results! However the more I used it, the more I realised I needed to be able to get the latest version of a file, without having to change all of my links in README's and HTML pages, and so GitCDN was born!
I absolutely love the service that Ryan has made available, and have used it for quite a while with great results! However the more I used it, the more I realized I needed to be able to get the latest version of a file, without having to change all of my links in README's and HTML pages, and so GitCDN was born!

As this service is free, I make no guarantees about Up-time nor do I have anything resembling an SLA.
If you're a company/service that needs that guarantee on your uptime (like an SLA), please consider using Cloudflare/MaxCDN directly.
Expand Down

0 comments on commit 99dc352

Please sign in to comment.