vbrandl/yagcdn
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
Backend for a git CDN with proper content types https://yagcdn.tk
190 Commits 3 Branches 0 Tags 338 KiB
Rust 69.3%
Elm 19.7%
HTML 3.7%
Dockerfile 3.4%
Shell 1.9%
Other 2%
7c20262146
Go to file
Valentin Brandl 7c20262146
Merge pull request #23 from vbrandl/dependabot/cargo/backend/structopt-0.3.3 
Bump structopt from 0.3.1 to 0.3.3 in /backend
2019-10-14 15:23:30 +02:00
.github/workflows Enable Github Actions 2019-09-09 21:43:28 +02:00
backend Merge pull request #23 from vbrandl/dependabot/cargo/backend/structopt-0.3.3 2019-10-14 15:23:30 +02:00
frontend Mention CSS framework 2019-08-12 20:14:58 +02:00
time-cache Link dockerignore 2019-08-07 22:24:38 +02:00
.drone.yml Enable CI 2019-08-09 19:22:30 +02:00
.env Rename env vars 2019-07-28 15:03:43 +02:00
docker-compose.yml Rename project 2019-08-09 19:43:58 +02:00
Dockerfile Rename project 2019-08-09 19:43:58 +02:00
README.md Add badges 2019-08-09 20:59:31 +02:00
update.sh Move update script 2019-07-29 22:38:13 +02:00
yagcdn.conf Rename config 2019-08-13 19:55:48 +02:00

README.md

YaGCDN

Hits-of-Code Drone build dependency status

YaGCDN 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, YaGCDN 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.

Variables

Environment Variable CLI Flag Description
GITHUB_CLIENT_SECRET --gh-secret GitHub OAuth2 secret (optional)
GITHUB_CLIENT_ID --gh-id GH OAuth2 Client ID (optional)
CF_ZONE_IDENT --cf-zone Cloudflare Zone identifier
CF_AUTH_USER --cf-auth-user CF API User (X-Auth-Email)
CF_AUTH_KEY --cf-auth-key CF API Key (X-Auth-Key)
YAGCDN_HOSTNAME --hostname Hostname (default: yagcdn.tk)