mirror of
https://github.com/syumai/workers.git
synced 2025-03-10 09:27:08 +00:00
129 lines
3.2 KiB
Markdown
129 lines
3.2 KiB
Markdown
# workers
|
|
|
|
[](https://pkg.go.dev/github.com/syumai/workers)
|
|
[](https://discord.gg/tYhtatRqGs)
|
|
|
|
* `workers` is a package to run an HTTP server written in Go on [Cloudflare Workers](https://workers.cloudflare.com/).
|
|
* This package can easily serve *http.Handler* on Cloudflare Workers.
|
|
* Caution: This is an experimental project.
|
|
|
|
## Features
|
|
|
|
* [x] serve http.Handler
|
|
* [ ] R2
|
|
- [x] Head
|
|
- [x] Get
|
|
- [x] Put
|
|
- [x] Delete
|
|
- [x] List
|
|
- [ ] Options for R2 methods
|
|
* [ ] KV
|
|
- [x] Get
|
|
- [x] List
|
|
- [x] Put
|
|
- [x] Delete
|
|
- [ ] Options for KV methods
|
|
* [x] Cache API
|
|
* [ ] Durable Objects
|
|
- [x] Calling stubs
|
|
* [x] D1 (alpha)
|
|
* [x] Environment variables
|
|
* [x] FetchEvent
|
|
* [x] Cron Triggers
|
|
* [x] TCP Sockets
|
|
* [x] Queues
|
|
- [x] Producer
|
|
- [x] Consumer
|
|
|
|
## Installation
|
|
|
|
```
|
|
go get github.com/syumai/workers
|
|
```
|
|
|
|
## Usage
|
|
|
|
implement your http.Handler and give it to `workers.Serve()`.
|
|
|
|
```go
|
|
func main() {
|
|
var handler http.HandlerFunc = func (w http.ResponseWriter, req *http.Request) { ... }
|
|
workers.Serve(handler)
|
|
}
|
|
```
|
|
|
|
or just call `http.Handle` and `http.HandleFunc`, then invoke `workers.Serve()` with nil.
|
|
|
|
```go
|
|
func main() {
|
|
http.HandleFunc("/hello", func (w http.ResponseWriter, req *http.Request) { ... })
|
|
workers.Serve(nil) // if nil is given, http.DefaultServeMux is used.
|
|
}
|
|
```
|
|
|
|
For concrete examples, see `_examples` directory.
|
|
|
|
## Quick Start
|
|
|
|
### Requirements
|
|
|
|
* Node.js (and npm)
|
|
* Go 1.24.0 or later
|
|
|
|
### Create a new Worker project
|
|
|
|
Run the following command:
|
|
|
|
```console
|
|
npm create cloudflare@latest -- --template github.com/syumai/workers/_templates/cloudflare/worker-go
|
|
```
|
|
|
|
### Initialize the project
|
|
|
|
1. Navigate to your new project directory:
|
|
|
|
```console
|
|
cd my-app
|
|
```
|
|
|
|
2. Initialize Go modules:
|
|
|
|
```console
|
|
go mod init
|
|
go mod tidy
|
|
```
|
|
|
|
3. Start the development server:
|
|
|
|
```console
|
|
npm start
|
|
```
|
|
|
|
4. Verify the worker is running:
|
|
|
|
```console
|
|
curl http://localhost:8787/hello
|
|
```
|
|
|
|
You will see **"Hello!"** as the response.
|
|
|
|
If you want a more detailed description, please refer to the README.md file in the generated directory.
|
|
|
|
## FAQ
|
|
|
|
### How do I deploy a worker implemented in this package?
|
|
|
|
To deploy a Worker, the following steps are required.
|
|
|
|
* Create a worker project using [wrangler](https://developers.cloudflare.com/workers/wrangler/).
|
|
* Build a Wasm binary.
|
|
* Upload a Wasm binary with a JavaScript code to load and instantiate Wasm (for entry point).
|
|
|
|
The [worker-go template](https://github.com/syumai/workers/tree/main/_templates/cloudflare/worker-go) contains all the required files, so I recommend using this template.
|
|
|
|
But Go (not TinyGo) with many dependencies may exceed the size limit of the Worker (3MB for free plan, 10MB for paid plan). In that case, you can use the [TinyGo template](https://github.com/syumai/workers/tree/main/_templates/cloudflare/worker-tinygo) instead.
|
|
|
|
### Where can I have discussions about contributions, or ask questions about how to use the library?
|
|
|
|
You can do both through GitHub Issues. If you want to have a more casual conversation, please use the [Discord server](https://discord.gg/tYhtatRqGs).
|