File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -19,6 +19,7 @@ pip3 install -r requirements.txt
1919```
2020
2121## Usage
22+ ### Local Usage
22231 . Install Dependencies
23242 . Configure the provider in XUnity.AutoTranslator:
2425 1 . Change Provider to 'CustomTranslate' in [ Service] section.
@@ -36,6 +37,28 @@ pip3 install -r requirements.txt
3637 python3 main.py
3738 ```
3839
40+ ### Docker Usage
41+ #### docker run
42+ If you want to run it with `docker run`, use command below.
43+
44+ ```bash
45+ docker run -d \
46+ --name xunity \
47+ -e BASE_URL="https://api.openai.com/v1" \
48+ -e API_KEY="api_key_here" \
49+ -e MODEL_NAME="gpt-3.5-turbo" \
50+ -e SQLITE_DB_PATH="translation.db"
51+ -v ./translation.db:/app/translation.db
52+ -p 5000:5000 \
53+ ghcr.io/returntofirst/xunity-autotranslator-openai:latest
54+ ```
55+ This command will server on port ` 5000 ` .
56+
57+ #### docker compose
58+ If you want to run this container with ` docker compose ` , use [ docker-compose.yaml] ( docker-compose.yaml ) to configure container
59+
60+ #### Kubernetes
61+ If you want to run this container with kubernetes, use [ k8s-example.yaml] ( k8s-example.yaml ) to configure container
3962## Features
4063### Translation Provider
4164- CustomTranslate Endpoint: Integrate with XUnity.AutoTranslator using a custom endpoint that leverages OpenAI's translation capabilities.
@@ -77,4 +100,8 @@ pip3 install -r requirements.txt
77100 - [ ] Task template
78101 - [ ] Translation history
79102 - [ ] Pre-translated dictonary
80- - [ ] Remove bad translation
103+ - [ ] Remove bad translation
104+ - [x] Deployment
105+ - [x] Github Actions
106+ - [x] Docker-compose
107+ - [x] Kubernetes
You can’t perform that action at this time.
0 commit comments