amasecocoa/deepargos repository overview

⁠DeepArgos

Argos Translate API compatible with DeepL API

It was created primarily for use in Misskey/Sharkey.

⁠Install

Whichever method you use, the first time you use it, it will take time because the model needs to be downloaded.

⁠With Docker

You can use DeepArgos by executing the following command.

$ mkdir deepargos
$ cd deepargos
$ wget -O compose.yml https://raw.githubusercontent.com/amsc-tech/DeepArgos/main/compose.yml
$ docker compose up

⁠Build it yourself

To build and run DeepArgos yourself, execute the following command:

$ mkdir deepargos
$ cd deepargos
$ git clone https://github.com/amsc-tech/DeepArgos.git .

Next, comment out image: in compose.yml and add build: . uncomment out and execute the following command

$ docker compose build

⁠Without Docker

Python and Rust, GCC or MSVC, and PDM are required.

execute the following command:

$ mkdir deepargos
$ cd deepargos
$ git clone https://github.com/amsc-tech/DeepArgos.git .
$ pdm install
$ pdm run serve # If you want to use Gunicorn as a worker, `pdm run gunicorn:serve` instead of this command

⁠How To Use

⁠Set AuthKey

If you do not want anyone to use the API without your permission, you can use environment variables (or .env) to make the AuthKey mandatory in order to use the API.

It is recommended to use uuid or similar for the authkey.

⁠example:

DA_AUTHKEY="authkey"