Skip to content

alpipego/workerist

Repository files navigation

Workerist

Workerist is a Cloudflare Worker designed to serve as a private Composer repository, utilizing Cloudflare's R2 storage for package distribution and Cloudflare Workers KV for authentication. This solution allows you to securely distribute PHP packages across your projects without setting up a dedicated package repository server.

Getting Started

Prerequisites

  • Cloudflare account with access to Workers and R2 storage
  • wrangler CLI installed (refer to the Wrangler documentation)
  • Node.js and npm

Setup

  1. Clone the repository:
git clone https://github.com/alpipego/workerist.git
  1. Navigate to the project directory:
cd workerist
  1. Install dependencies:
npm install
  1. Configuration:

Copy the wrangler.toml.example file to wrangler.toml:

cp wrangler.toml.example wrangler.toml

Edit wrangler.toml and add the kv_namespace ID and the R2 bucket name to the appropriate fields.

Deployment

Deploy the worker using the wrangler CLI:

wrangler deploy

Usage

Configure your Composer projects to use this worker as a private repository. For detailed instructions on the setup and use, please refer to our in-depth blog post.

Contributing

Contributions are welcome! Please feel free to submit pull requests or open issues to discuss potential improvements or features.

License

This project is open-sourced under the MIT License - see the LICENSE file for details.

Additional Resources

About

Cloudflare worker for serverless private PHP package repository.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published