mirror of
https://github.com/OwO-Network/DeepLX.git
synced 2025-04-19 14:13:24 +00:00
204 lines
6.1 KiB
Markdown
204 lines
6.1 KiB
Markdown
<!--
|
|
* @Author: Vincent Young
|
|
* @Date: 2022-10-18 07:32:29
|
|
* @LastEditors: Vincent Young
|
|
* @LastEditTime: 2023-10-28 22:45:58
|
|
* @FilePath: /DeepLX/README.md
|
|
* @Telegram: https://t.me/missuo
|
|
*
|
|
* Copyright © 2022 by Vincent, All Rights Reserved.
|
|
-->
|
|
|
|
[![GitHub Workflow][1]](https://github.com/OwO-Network/DeepLX/actions)
|
|
[![Go Version][2]](https://github.com/OwO-Network/DeepLX/blob/main/go.mod)
|
|
[![Go Report][3]](https://goreportcard.com/badge/github.com/OwO-Network/DeepLX)
|
|
[![Maintainability][4]](https://codeclimate.com/github/OwO-Network/DeepLX/maintainability)
|
|
[![GitHub License][5]](https://github.com/OwO-Network/DeepLX/blob/main/LICENSE)
|
|
[![Docker Pulls][6]](https://hub.docker.com/r/missuo/deeplx)
|
|
[![Releases][7]](https://github.com/OwO-Network/DeepLX/releases)
|
|
|
|
[1]: https://img.shields.io/github/actions/workflow/status/OwO-Network/DeepLX/build.yml?logo=github
|
|
[2]: https://img.shields.io/github/go-mod/go-version/OwO-Network/DeepLX?logo=go
|
|
[3]: https://goreportcard.com/badge/github.com/OwO-Network/DeepLX
|
|
[4]: https://api.codeclimate.com/v1/badges/b5b30239174fc6603aca/maintainability
|
|
[5]: https://img.shields.io/github/license/OwO-Network/DeepLX
|
|
[6]: https://img.shields.io/docker/pulls/missuo/deeplx?logo=docker
|
|
[7]: https://img.shields.io/github/v/release/OwO-Network/DeepLX?logo=smartthings
|
|
|
|
## **Related Projects**
|
|
[OwO-Network/PyDeepLX](https://github.com/OwO-Network/PyDeepLX): Python Package for DeepLX.
|
|
|
|
[OwO-Network/gdeeplx](https://github.com/OwO-Network/gdeeplx): Golang Package for DeepLX.
|
|
|
|
[ifyour/deeplx](https://github.com/ifyour/deeplx): JS Package for DeepLX.
|
|
|
|
## Discussion Group
|
|
[Telegram Group](https://t.me/+8KDGHKJCxEVkNzll)
|
|
|
|
## Description
|
|
- `DeepLX` is listening to `0.0.0.0:1188` by default. You can modify the listening port by yourself.
|
|
- `DeepLX` is using `DeepL` Free API.
|
|
- `DeepLX` is unlimited to the number of requests.
|
|
|
|
## Usage
|
|
### Request Parameters
|
|
- text: string
|
|
- source_lang: string
|
|
- target_lang: string
|
|
|
|
### Response
|
|
```json
|
|
{
|
|
"alternatives": [
|
|
"no one else",
|
|
"there is no other person (idiom); there is no one else",
|
|
"there is no other person"
|
|
],
|
|
"code": 200,
|
|
"data": "there is no one else",
|
|
"id": 8352115005,
|
|
"source_lang": "ZH",
|
|
"target_lang": "EN"
|
|
}
|
|
```
|
|
### Specify the port (Optional)
|
|
**Thanks to [cijiugechu](https://github.com/cijiugechu) for [his contribution](https://github.com/OwO-Network/DeepLX/commit/4a0920579ea868b0f05ccdff6bceae316bfd5dc8) to make this feature possible for this project!**
|
|
```bash
|
|
./deeplx -p 3333
|
|
# or
|
|
./deeplx -port 3333
|
|
```
|
|
### Set access password (Optional)
|
|
**To prevent abuse of your public API, you can use a token to restrict translation requests.**
|
|
```bash
|
|
./deeplx -token hellodeeplx
|
|
```
|
|
|
|
```
|
|
curl -X POST http://localhost:1188/translate \
|
|
-H "Content-Type: application/json" \
|
|
-H "Authorization: Bearer your_access_token" \
|
|
-d '{
|
|
"text": "Hello, world!",
|
|
"source_lang": "EN",
|
|
"target_lang": "DE"
|
|
}'
|
|
|
|
```
|
|
|
|
### Run with Docker
|
|
```bash
|
|
# ghcr.io
|
|
docker run -itd -p 1188:1188 ghcr.io/owo-network/deeplx:latest
|
|
|
|
# dockerhub
|
|
docker run -itd -p 1188:1188 missuo/deeplx:latest
|
|
```
|
|
|
|
### Run with Docker Compose
|
|
```bash
|
|
mkdir deeplx
|
|
cd deeplx
|
|
wget https://raw.githubusercontent.com/OwO-Network/DeepLX/main/docker-compose.yaml
|
|
# docker compose v1
|
|
docker-compose up -d
|
|
# or docker compose v2
|
|
docker compose up -d
|
|
```
|
|
|
|
### Run on Linux Server
|
|
```bash
|
|
bash <(curl -Ls https://raw.githubusercontent.com/OwO-Network/DeepLX/main/install.sh)
|
|
# or
|
|
bash <(curl -Ls https://qwq.mx/deeplx)
|
|
```
|
|
|
|
### Run on Mac
|
|
#### Homebrew (Recommended)
|
|
**Homebrew has been fixed in the latest version and works perfectly.**
|
|
```bash
|
|
brew tap owo-network/brew
|
|
brew install deeplx
|
|
brew services start owo-network/brew/deeplx
|
|
|
|
# Update to the latest version
|
|
brew update
|
|
brew upgrade deeplx
|
|
brew services restart owo-network/brew/deeplx
|
|
|
|
# View the currently installed version
|
|
brew list --versions deeplx
|
|
```
|
|
|
|
#### Manual
|
|
1. Download the latest release of DeepL X.
|
|
```bash
|
|
sudo mv deeplx_darwin_amd64 /usr/local/bin/deeplx
|
|
sudo chmod +x /usr/local/bin/deeplx
|
|
```
|
|
|
|
2. Download the `me.missuo.deeplx.plist` to `~/Library/LaunchAgents`.
|
|
```bash
|
|
wget https://raw.githubusercontent.com/OwO-Network/DeepLX/main/me.missuo.deeplx.plist -O ~/Library/LaunchAgents/me.missuo.deeplx.plist
|
|
```
|
|
3. Run following command.
|
|
```bash
|
|
launchctl load ~/Library/LaunchAgents/me.missuo.deeplx.plist
|
|
launchctl start ~/Library/LaunchAgents/me.missuo.deeplx.plist
|
|
```
|
|
|
|
### Install from AUR
|
|
```bash
|
|
paru -S deeplx-bin
|
|
```
|
|
|
|
After installation, start the daemon with the following command.
|
|
|
|
```bash
|
|
systemctl daemon-reload
|
|
systemctl enable deeplx
|
|
|
|
```
|
|
## Setup on [Bob App](https://bobtranslate.com/)
|
|
1. Install [bob-plugin-deeplx](https://github.com/missuo/bob-plugin-deeplx) on Bob.
|
|
|
|
2. Setup the API. (If you use Brew to install locally you can skip this step)
|
|
|
|
|
|
## Setup on [immersive-translate](https://github.com/immersive-translate/immersive-translate)
|
|
**It is not recommended, because the `immersive-translate` will send many requests in a short time, which will cause the `DeepL API` to block your IP.**
|
|
|
|
1. Install Latest [immersive-translate ](https://github.com/immersive-translate/immersive-translate/releases) on your browser.
|
|
|
|
2. Click on **Developer Settings** in the bottom left corner. **Enable Beta experimental features**.
|
|
|
|
3. Set the URL. (If you are not deploying locally, you need to change 127.0.0.1 to the IP of your server)
|
|
|
|
|
|
|
|
## Use in Python
|
|
```python
|
|
import httpx, json
|
|
|
|
deeplx_api = "http://127.0.0.1:1188/translate"
|
|
|
|
data = {
|
|
"text": "Hello World",
|
|
"source_lang": "EN",
|
|
"target_lang": "ZH"
|
|
}
|
|
|
|
post_data = json.dumps(data)
|
|
r = httpx.post(url = deeplx_api, data = post_data).text
|
|
print(r)
|
|
```
|
|
|
|
## Backup the Docker Image of zu1k
|
|
```shell
|
|
docker run -itd -p 1188:80 missuo/deeplx-bk
|
|
```
|
|
**This docker image is not related to this project, as the original author deleted the image, it is only for backup.**
|
|
|
|
## License
|
|
[](https://app.fossa.com/projects/git%2Bgithub.com%2FOwO-Network%2FDeepLX?ref=badge_large)
|