Built and signed on GitHub ActionsBuilt and signed on GitHub Actions
🚚 Deliver any files in the GitHub repository
Reproxy
💡 Concepts
You can host your specific file on the GitHub repository.
The usage I assume is for one-line scripts.
(i.e. dotfiles or some install scripts, like curl https://example.com | sh)
If you access from browsers, you'll redirected to the GitHub page, not a raw file.
For the development or testing, you can access to the different branches or tags.
To do this, simply add the ref name to the sub-directory.
(i.e. curl https://example.com/ref | sh)
🔧 Setup
💻 On Local
-
Copy the
.env.tmplto.envand edit as you prefer -
Follow the steps depending on the runtime
🦕 Use Deno Deploy
-
Replace the default code with this
import "jsr:@5ouma/reproxy"; -
Set the environment variables (Don't forget!!)
☁️ Use Cloudflare Workers
-
Set up the
wrangler.toml -
Add this code to the
index.tsimport "@5ouma/reproxy"; -
Deploy with these commands
npx jsr add @5ouma/reproxy npx wrangler deploy index.ts
🔨 Development
-
Clone this repository
git clone https://github.com/5ouma/reproxy.git -
Copy the
.env.tmplto.envand edit as you prefer -
Run the
server.tsvia these task runners# For production deno task start# For development deno task dev
🌍 Environment Variables
| Name | Required |
|---|---|
REPOSITORY_OWNER |
yes |
REPOSITORY_NAME |
yes |
REPOSITORY_PATH |
yes |
GITHUB_TOKEN |
no |
You need to add GITHUB_TOKEN if you want to:
- Access the file in the private repository
- Avoid the API usage limit
🆘 Help
- ⚠️ Issues: Feature Requests or Bug Reports
- 💬 Discussions: General Chats or Questions
- 🛡️ Security Advisories: Security Issues that should not be public
🎽 Contributing
I happily welcome your contributions! Before you contribute, I would recommend reading CONTRIBUTING.md for a better development experience.