# DeepL X Permanently free DeepL API written in Golang ## 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": [ "Undisputed", "Unquestionable", "Unquestionably" ], "code": 200, "data": "Undoubtedly", "id": 8300079001 } ``` ### Specify the port **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 ``` ### 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://cpp.li/deeplx) ``` ### Run on Mac #### Homebrew (Recommended) **For unknown reasons v0.7.8 does not work properly with Homebrew, so we are still using v0.7.7 for our version of Homebrew, it has no bugs and it is almost perfect.** ```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.** ## Author **DeepL X** © [DeepL X Contributors](https://github.com/OwO-Network/DeepLX/graphs/contributors), Released under the [MIT](./LICENSE) License.