directus-extension-auto-translation

Directus Extension Auto Translation

directus-extension-auto-translation

About

This extension automatically translates Directus collections translation fields. This will be achieved by DeepL integration.

With a free DeepL account you can translate 500.000 words per month free.

Requirements

• DeepL Auth-Key (free or pro)
  • https://www.deepl.com/de/docs-api/api-access/authentication/

Installation

• https://docs.directus.io/extensions/installing-extensions.html

1. Backup your database!

2. Installing via the npm Registry

   • Dockerfile

     RUN pnpm install  directus-extension-auto-translation
     

3. [Recommended]

   • Disable saving API key into database.
   • a)
     • Add the env Variable: AUTO_TRANSLATE_API_KEY_SAVING_PATH which holds a path
     • Since saving an API key in the database is never a good idea. This allows us, to save the Key into a File.
     • This allows your customers to dynamically change the API key.
     • setup:
       • volumes:
         • - ./secrets:/directus/secrets
       • env section:
         • AUTO_TRANSLATE_API_KEY_SAVING_PATH: "/directus/secrets/api-key-in-file.txt"
   • b)
     • Add the env Variable: AUTO_TRANSLATE_API_KEY which holds the api key
     • This does not allow dynamically changing the API key as in option a)

4. Follow the instructions in your Directus App add the new created table (auto_translation_settings)

Usage

This example shows how to use the extension for a collection wikis

1. Add a translation type field to your collection
2. Directus automatically creates a wikis_translations and languages collection
3. In this translation collection (wikis_translations)
   • Add a be_source_for_translations field (default: true)
     • This field is used to determine if the translation is the source of the translation
   • Add a let_be_translated field (default: true)
     • This field is used to determine if the record should be translated

If you now create or update a record in the wikis collection with a translation it will be automatically translated.

Contributors

The FireboltCasters