{"id":18712438,"url":"https://github.com/serkodev/cloudflare-kv-server","last_synced_at":"2025-04-12T11:54:02.034Z","repository":{"id":116427800,"uuid":"547171376","full_name":"serkodev/cloudflare-kv-server","owner":"serkodev","description":"Cloudflare KV Server with JWT auth (Cloudflare Workers® ready)","archived":false,"fork":false,"pushed_at":"2024-01-05T08:47:42.000Z","size":868,"stargazers_count":17,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-11T16:10:59.109Z","etag":null,"topics":["cloudflare","cloudflare-workers","jwt","jwt-authentication","kv","proxy","worker","workers","workers-kv"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/serkodev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-10-07T08:46:01.000Z","updated_at":"2025-01-23T00:23:18.000Z","dependencies_parsed_at":"2024-11-07T12:45:52.961Z","dependency_job_id":null,"html_url":"https://github.com/serkodev/cloudflare-kv-server","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/serkodev%2Fcloudflare-kv-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/serkodev%2Fcloudflare-kv-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/serkodev%2Fcloudflare-kv-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/serkodev%2Fcloudflare-kv-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/serkodev","download_url":"https://codeload.github.com/serkodev/cloudflare-kv-server/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248565045,"owners_count":21125414,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cloudflare","cloudflare-workers","jwt","jwt-authentication","kv","proxy","worker","workers","workers-kv"],"created_at":"2024-11-07T12:42:49.346Z","updated_at":"2025-04-12T11:54:02.010Z","avatar_url":"https://github.com/serkodev.png","language":"TypeScript","readme":"# cloudflare-kv-server\n\nOne-click deploy a KV server to Cloudflare Workers. It is similar to [Cloudflare API for KV](https://api.cloudflare.com/#workers-kv-namespace-list-a-namespace-s-keys) but you just need a self-generate JWT token instead of using Cloudflare auth key and email. You can also customize each JWT token with expiry date, action permissions or whitelist key patterns. \n\n## Deploy to Cloudflare Workers\n\n1. Clone this repo\n2. Config `wrangler.toml` and set `name`, `kv_namespaces`\n4. Run `wrangler login` and `wrangler publish`\n\n### Auth Token\n\nIts optional but recommend to set a Secret to protect your endpoint. You can either set `AUTH_SECRET` in `wrangler.toml` or set a secret binding in Cloudflare Workers dashboard to increase security.\n\nAfter setting a Secret, you can use [Online Token Generator](https://cf-kv-server-token-gen.pages.dev/) to generate token or build it yourself (`./packages/auth-token-gen`).\n\nPlease make sure you use the same Secret to match the token generator.\n\n## Client API\n\n### Auth header\nIf you setup an auth secret and generated a token please include it in `Authorization` HTTP header field with `Bearer \u003cJWT auth token\u003e` value. For example:\n\n```\nAuthorization: Bearer xxxxxx.xxxxxxxxxxx.xxxxxxxxxxxxxx\n```\n\n### End points\nList keys\n\u003e Permission: List\n```\nGET :namespace_identifier/keys\n\nURL Query Params:\nlimit, cursor, prefix\n```\n\nGet value\n\u003e Permission: Get\n```\nGET :namespace_identifier/values/:key_name\n\nURL Query Params:\ncache_ttl\n```\n\nGet value metadata\n\u003e Permission: GetWithMetaData\n```\nGET :namespace_identifier/values_metadata/:key_name\n\nURL Query Params:\ncache_ttl\n```\n\nPut value to key  \n\u003e Permission: Put\n```\nPUT :namespace_identifier/values/:key_name\n\nURL Query Params:\nexpiration, expiration_ttl, metadata\n```\n\nDelete key\n\u003e Permission: Delete\n```\nDELETE :namespace_identifier/values/:key_name\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fserkodev%2Fcloudflare-kv-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fserkodev%2Fcloudflare-kv-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fserkodev%2Fcloudflare-kv-server/lists"}