mirror of https://github.com/OwO-Network/DeepLX.git synced 2024-11-16 04:42:20 +08:00

DeepL Free API (No TOKEN required)

Go to file

Vincent Young cbd1507335 docs: modify to the latest response demo		2023-03-16 20:25:44 +08:00
.github/workflows	chore: fix dockerhub bug	2023-03-07 02:57:58 +08:00
.cross_compile.sh	fix: disable cgo	2023-02-18 20:46:16 +08:00
.gitignore	fix: possible bugs	2023-02-12 09:23:04 +08:00
deeplx.service	Update deeplx.service	2023-02-18 20:55:20 +08:00
docker-compose.yaml	chore: add docker-compose	2023-03-07 03:12:31 +08:00
Dockerfile	Create Dockerfile	2023-02-27 00:03:11 +08:00
go.mod	feat: return full alternatives	2023-03-16 20:23:21 +08:00
go.sum	feat: return full alternatives	2023-03-16 20:23:21 +08:00
install.sh	Update install.sh	2023-02-18 20:57:58 +08:00
LICENSE	Create LICENSE	2022-10-20 02:12:18 +08:00
main.go	feat: return full alternatives	2023-03-16 20:23:21 +08:00
me.missuo.deeplx.plist	Update README.md	2022-10-20 02:11:14 +08:00
README.md	docs: modify to the latest response demo	2023-03-16 20:25:44 +08:00

README.md

DeepL X

Permanently free DeepL API written in Golang

Description

deeplx in only run in port 1188, later versions will do the specified port.
deeplx is listening to 0.0.0.0:1188 by default.
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

{
  "alternatives": [
    "Undisputed",
    "Unquestionable",
    "Unquestionably"
  ],
  "code": 200,
  "data": "Undoubtedly",
  "id": 8300079001
}

Run with Docker

# 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

mkdir deeplx
cd deeplx
wget https://raw.githubusercontent.com/OwO-Network/DeepLX/main/docker-compose.yaml
docker-compose up -d

Run on Linux Server

bash <(curl -Ls https://cpp.li/deeplx)

Run on Mac

Homebrew (Recommended)

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

Download the latest release of DeepL X.

sudo mv deeplx_darwin_amd64 /usr/local/bin/deeplx
sudo chmod +x /usr/local/bin/deeplx

Download the me.missuo.deeplx.plist to ~/Library/LaunchAgents.

wget https://raw.githubusercontent.com/OwO-Network/DeepLX/main/me.missuo.deeplx.plist -O ~/Library/LaunchAgents/me.missuo.deeplx.plist

Run following command.

launchctl load ~/Library/LaunchAgents/me.missuo.deeplx.plist
launchctl start ~/Library/LaunchAgents/me.missuo.deeplx.plist

Install from AUR

paru -S deeplx-bin

After installation, start the daemon with the following command.

systemctl daemon-reload
systemctl enable deeplx

Setup on Bob App

Install bob-plugin-deeplx on Bob.
Setup the API. (If you use Brew to install locally you can skip this step)

Setup on 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.

Install Latest immersive-translate on your browser.
Click on Developer Settings in the bottom left corner. Enable Beta experimental features.
Set the URL. (If you are not deploying locally, you need to change 127.0.0.1 to the IP of your server)

Backup the Docker Image of zu1k

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.