Skip to content

Latest commit

 

History

History
67 lines (47 loc) · 1.82 KB

README.en.md

File metadata and controls

67 lines (47 loc) · 1.82 KB

KISS-WORKER

A simple data sync service for KISS-Translator.

There are two deployment methods to choose from:

cloudflare workers deployment method

Prerequisites

  • Cloudflare account
  • Install git + nodejs locally when deploying
  • A domain name (optional)

Deployment steps

  1. Log in to the Cloudflare management panel and go to the path dashboard > select Workers & Pages > KV. Create a namespace with whatever name you want. After creation, a namespace ID will be obtained.

  2. Clone the project, modify the wrangler.toml file, and replace the namespace ID obtained in the previous step to the position of id.

# wrangler.toml
kv_namespaces = [
    { binding = "KV", id = "replace you id here!!!" }
]
  1. Execute the following commands in sequence. When the execution is completed, you will be asked to set your own password. You may need to connect to Cloudflare authorization when deploying for the first time.
yarn install
yarn deploy
  1. (Optional) Log in to the Cloudflare management panel, enter the path dashboard > select Workers & Pages > kiss-worker, click the Trigger tab, and then click Add Custom Domain to add a domain name to access.

docker deployment method

Prerequisites

  • Own server
  • docker related knowledge

Deployment steps

  1. Clone the project and modify the docker-compose.yml file to change the characters after APP_KEY to your own password.
version: "3.1"
services:
  kiss-worker:
    image: fishjar/kiss-worker
    environment:
      PORT: 8080
      APP_KEY: 123456 # Change password here
      APP_DATAPATH: data
    ports:
      - 8080:8080
    volumes:
      - ./data:/app/data
  1. Execute the following command to start
docker-compose up -d