Permalink
Browse files

FAQ: Remove hard line breaks to make editing on the web easier

  • Loading branch information...
rgrove committed Aug 5, 2017
1 parent c8463c4 commit 9d01f155a8a87944f5031a40cbdd270b6056144b
Showing with 19 additions and 65 deletions.
  1. +19 −65 FAQ.md
View
84 FAQ.md
@@ -6,26 +6,15 @@ Hi, I'm [Ryan Grove](http://wonko.com/).
## Why is this necessary? Can't I just load files from GitHub directly?
When you request certain types of files (like JavaScript, CSS, or HTML) from
`raw.githubusercontent.com` or `gist.githubusercontent.com`, GitHub serves them
with a `Content-Type` header set to `text/plain`. As a result, most modern
browsers won't actually interpret these files as JavaScript, CSS, or HTML and
will instead just display them as text.
GitHub does this because serving raw files from a git repo is inefficient and
they want to discourage people from using their GitHub repos for static file
hosting.
RawGit acts as a caching proxy. It forwards requests to GitHub, caches the
responses, and relays them to your browser with an appropriate `Content-Type`
header based on the extension of the file that was requested. The caching layer
ensures that minimal load is placed on GitHub, and you get quick and easy static
file hosting right from a GitHub repo. Everyone's happy!
When you request certain types of files (like JavaScript, CSS, or HTML) from `raw.githubusercontent.com` or `gist.githubusercontent.com`, GitHub serves them with a `Content-Type` header set to `text/plain`. As a result, most modern browsers won't actually interpret these files as JavaScript, CSS, or HTML and will instead just display them as text.
GitHub does this because serving raw files from a git repo is inefficient and they want to discourage people from using their GitHub repos for static file hosting.
RawGit acts as a caching proxy. It forwards requests to GitHub, caches the responses, and relays them to your browser with an appropriate `Content-Type` header based on the extension of the file that was requested. The caching layer ensures that minimal load is placed on GitHub, and you get quick and easy static file hosting right from a GitHub repo. Everyone's happy!
## Is RawGit associated with GitHub?
No, RawGit is not associated with GitHub in any way. Please don't contact GitHub
asking for help with RawGit.
No, RawGit is not associated with GitHub in any way. Please don't contact GitHub asking for help with RawGit.
## What's the difference between development and CDN URLs?
@@ -57,77 +46,42 @@ Please don't use RawGit for things like this.
## How long does the CDN cache files? How can I make it refresh my file?
The CDN caches files permanently based on their path. It ignores query strings.
This is done to improve performance and to make it possible for the CDN to
handle massive amounts of traffic without causing excessive load on RawGit or
GitHub's servers.
The CDN caches files permanently based on their path. It ignores query strings. This is done to improve performance and to make it possible for the CDN to handle massive amounts of traffic without causing excessive load on RawGit or GitHub's servers.
To ensure that the CDN always serves the version of the file you want, use a git
tag or commit hash in the file's path instead of a branch name, and update the
URL if you push a new version of the file.
To ensure that the CDN always serves the version of the file you want, use a git tag or commit hash in the file's path instead of a branch name, and update the URL if you push a new version of the file.
So, instead of a URL like `https://cdn.rawgit.com/user/repo/branch/file`, use a
URL like `https://cdn.rawgit.com/user/repo/tag/file` or
`https://cdn.rawgit.com/user/repo/commit/file`.
So, instead of a URL like `https://cdn.rawgit.com/user/repo/branch/file`, use a URL like `https://cdn.rawgit.com/user/repo/tag/file` or `https://cdn.rawgit.com/user/repo/commit/file`.
## I need guaranteed 100% uptime. Should I use cdn.rawgit.com?
No. RawGit is a free, best-effort service and cannot provide any uptime or
support guarantees, even for the CDN.
No. RawGit is a free, best-effort service and cannot provide any uptime or support guarantees, even for the CDN.
While I do my best to keep things running, things sometimes go wrong. Sometimes
there are network or provider issues outside my control. Sometimes abusive
traffic temporarily affects response times. Sometimes things break while I'm
asleep and I don't know there are problems until I wake up. And sometimes I
break things by doing something dumb (although I try really hard not to).
While I do my best to keep things running, things sometimes go wrong. Sometimes there are network or provider issues outside my control. Sometimes abusive traffic temporarily affects response times. Sometimes things break while I'm asleep and I don't know there are problems until I wake up. And sometimes I break things by doing something dumb (although I try really hard not to).
Since I run RawGit in my spare time, with my own money and with CDN hosting
generously donated by [StackPath](https://stackpath.com/), it has a budget
that's probably less than you pay for coffee in a given month. My goal is to
help other open source developers get their projects up and running, but if you
need to serve files that are crucial to your business, you should pay for a host
with well-funded infrastructure and uptime guarantees.
Since I run RawGit in my spare time, with my own money and with CDN hosting generously donated by [StackPath](https://stackpath.com/), it has a budget that's probably less than you pay for coffee in a given month. My goal is to help other open source developers get their projects up and running, but if you need to serve files that are crucial to your business, you should pay for a host with well-funded infrastructure and uptime guarantees.
## Why do anonymous gist URLs return 403 errors?
RawGit doesn't serve anonymous gists because they're frequently used for illegal
or abusive content. Sorry.
RawGit doesn't serve anonymous gists because they're frequently used for illegal or abusive content. Sorry.
## I moved a file in my repo and now old RawGit URLs are broken. Is there any way to redirect to the new file?
[There sure
is](https://github.com/rgrove/rawgit/wiki/How-to-redirect-a-RawGit-URL-to-another-URL-or-GitHub-file)
(for non-CDN URLs, anyway). But in the future, you might want to consider using
URLs based on a tag or commit ref rather than a branch, since tags and commits
always represent a single point in time and won't break if you move a file
later.
[There sure is](https://github.com/rgrove/rawgit/wiki/How-to-redirect-a-RawGit-URL-to-another-URL-or-GitHub-file) (for non-CDN URLs, anyway). But in the future, you might want to consider using URLs based on a tag or commit ref rather than a branch, since tags and commits always represent a single point in time and won't break if you move a file later.
## Does RawGit work for private repositories?
Nope. [I don't want your secrets flowing through RawGit](https://github.com/rgrove/rawgit/issues/62).
## Can I donate money/Bitcoin/pie to help you out?
It's super nice of you to offer, but I don't need any donations at this time.
RawGit's server costs are minimal, and the lovely people at
[StackPath](https://stackpath.com/) provide RawGit's CDN service free of charge.
Thank you though!
It's super nice of you to offer, but I don't need any donations at this time. RawGit's server costs are minimal, and the lovely people at [StackPath](https://stackpath.com/) provide RawGit's CDN service free of charge. Thank you though!
## I have feedback or want to report a problem! Who can I contact?
- To report a critical issue like RawGit being broken or to share general
feedback, send a tweet to [@rawgit](https://twitter.com/rawgit) or
[@yaypie](https://twitter.com/yaypie). I try to respond quickly when I'm
awake and near a computer, but sometimes I do have to sleep. If you don't
get a response, just wait longer.
- To report a critical issue like RawGit being broken or to share general feedback, send a tweet to [@rawgit](https://twitter.com/rawgit) or [@yaypie](https://twitter.com/yaypie). I try to respond quickly when I'm awake and near a computer, but sometimes I do have to sleep. If you don't get a response, just wait longer.
- To report a non-critical issue, please
[file an issue](https://github.com/rgrove/rawgit/issues) on RawGit's GitHub
project.
- To report a non-critical issue, please [file an issue](https://github.com/rgrove/rawgit/issues) on RawGit's GitHub project.
- To report a security concern, please email `security@rawgit.com` privately.
Feel free to encrypt your email using [my public key](https://rawgit.com/public-key.txt)
if you're paranoid. Expect a response within 48 hours.
- To report a security concern, please email `security@rawgit.com` privately. Feel free to encrypt your email using [my public key](https://rawgit.com/public-key.txt) if you're paranoid. Expect a response within 48 hours.
- To file a DMCA takedown notification or counter-notification, see
[RawGit's DMCA Notice & Takedown Procedure](DMCA.md)
- To file a DMCA takedown notification or counter-notification, see [RawGit's DMCA Notice & Takedown Procedure](DMCA.md)

0 comments on commit 9d01f15

Please sign in to comment.