1
0
Fork 0
mirror of https://github.com/xHyroM/waki.git synced 2024-11-22 06:51:04 +01:00

docs: readme

This commit is contained in:
Jozef Steinhübl 2024-05-20 13:01:49 +02:00
parent 5e93be5083
commit d881696a84
No known key found for this signature in database
GPG key ID: E6BC90C91973B08F

33
README.md Normal file
View file

@ -0,0 +1,33 @@
**Waki** stands for **Wak**aTime **I**ntegration Proxy. It is a simple proxy server that forwards requests to multiple WakaTime instances.
Runs fully on [Cloudflare Workers](https://workers.cloudflare.com/).
## Requirements
- [node.js](https://nodejs.org/)
- [pnpm](https://pnpm.js.org/)
- [cloudflare account](https://cloudflare.com)
## How to setup
After cloning the repository and installing the dependencies, you need to run the following command to deploy the worker:
```bash
pnpm run deploy
```
Then, you need to set the following environment variables in your Cloudflare account:
- `API_TOKEN` - randomly generated token that will be used to authenticate requests
- `PROVIDERS` - list of WakaTime instances (in JSON format)
- `MAIN_PROVIDER` - main WakaTime instance which will be used to retrieve the user's data, etc...
Look at the `vars.example` file for more information.
You can set the environment variables using the Cloudflare dashboard or using the `wrangler` CLI.
```bash
wrangler secret put API_TOKEN
wrangler secret put PROVIDERS
wrangler secret put MAIN_PROVIDER
```