vbrandl/yagcdn
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Add README.md

Browse Source
This commit is contained in:
Valentin Brandl 2019-07-27 13:24:09 +02:00
parent 865cf36bcf
commit 4f88410743
No known key found for this signature in database
GPG Key ID: 30D341DD34118D7D
1 changed files with 26 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md Normal file
View File

@ -0,0 +1,26 @@
# Gitache
Gitache is a web service that serves raw files from GitHub, GitLab and Bitbucket
with the proper `Content-Type` headers. Requests to a branch will be redirected
to the branches `HEAD`. Requests to a specific commit will also set long time
cache headers, so the service can be put behind a CDN like Cloudflare.
The endpoints follow the pattern `/<service>/<user>/<repo>/<gitref>/<file>`
where `<service>` is one of `github`, `gitlab` or `bitbucket`, `<gitref>` is the
name of the branch or a commit hash.
## Building and Running
The code can be built natively using `cargo build --release` or as a Docker
image using `docker build .`
The easiest way to run the service is by using `docker-compose up -d` and
exposing port `8080`.
## API Limits
To get the `HEAD` of a requested branch, Gitache sends a request to the
requested service's API. To prevent running into rate limiting issues with the
GitHub API, an OAuth2 App should be created and the client ID and secret can be
set via the `GITHUB_CLIENT_ID` and `GITHUB_CLIENT_SECRET` environment variables.