Skip to content
Snippets Groups Projects
README.rst 2.92 KiB
Newer Older
oury.balde's avatar
oury.balde committed
Redner
.. |maturity| image:: https://img.shields.io/badge/maturity-Stable-green.png
    :target: https://odoo-community.org/page/development-status
    :alt: Stable
.. |license| image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg
    :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
    :alt: License: AGPL-3
Vincent Hatakeyama's avatar
Vincent Hatakeyama committed
.. |ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
Axel Prel's avatar
Axel Prel committed
    :target: https://github.com/astral-sh/ruff
    :alt: Ruff
.. |prettier| image:: https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square
    :target: https://github.com/prettier/prettier
    :alt: Prettier

|maturity| |license| |ruff| |prettier|
Produce reports & emails with Rednerd_.
Rednerd_ is an innovative solution to produce transactional emails
oury.balde's avatar
oury.balde committed
and documents in PDF or HTML format.

It's designed to help applications or websites that need to send transactional
email like password resets, order confirmations, and welcome messages.

Vincent Hatakeyama's avatar
Vincent Hatakeyama committed
With Rednerd_, you can create clear, professional reports and responsive email templates.
The module supports email templates designed in the Mailjet app, using MJML or Mustache.

Seamless Integration with Odoo ERP
----------------------------------

Rednerd is fully integrated with Odoo ERP, allowing you to customize your MJML email templates directly in Odoo before sending the final version to Rednerd.

Document Rendering Made Easy
----------------------------

This solution also enables automatic rendering of PDF or HTML. Quotes, invoices, or any other document can be automatically generated from your application data.
oury.balde's avatar
oury.balde committed

Vincent Hatakeyama's avatar
Vincent Hatakeyama committed
How To Get Started?
-------------------

Vincent Hatakeyama's avatar
Vincent Hatakeyama committed
Go to https://redner.orbeet.io/sign-in to create your account and set up your API key to connect Rednerd to your application.
Alternatively check our step-by-step tutorials_.
oury.balde's avatar
oury.balde committed

Vincent Hatakeyama's avatar
Vincent Hatakeyama committed
Once your account is ready, configure the module with the following ``ir.config_parameter``::

Vincent Hatakeyama's avatar
Vincent Hatakeyama committed
  rednerd.server_url = https://redner.orbeet.io
Vincent Hatakeyama's avatar
Vincent Hatakeyama committed
  rednerd.api_key = <your API key here>
  redner.account = <your account name>
  redner.timeout = 20
oury.balde's avatar
oury.balde committed

``redner.timeout`` is in seconds; defaults to 20 seconds per redner call.
oury.balde's avatar
oury.balde committed

**Pro tip**: You can use mjml-app_ to prototype your email templates.

Vincent Hatakeyama's avatar
Vincent Hatakeyama committed
Documentation
-------------

Vincent Hatakeyama's avatar
Vincent Hatakeyama committed
If you need further information concerning Redner integration with Odoo ERP, you can check our step-by-step tutorials_.
Vincent Hatakeyama's avatar
Vincent Hatakeyama committed
Feel free to visit Orbeet_ website to discover all our solutions.

oury.balde's avatar
oury.balde committed
UI Changes
----------
oury.balde's avatar
oury.balde committed
* Setting > Redner > Templates
oury.balde's avatar
oury.balde committed

Note: When you have existing templates you want to register onto a new
oury.balde's avatar
oury.balde committed
redner server (or with a new user), multi-select them and click
"Send to redner server".
oury.balde's avatar
oury.balde committed

.. _mjml-app: http://mjmlio.github.io/mjml-app/
.. _Rednerd: https://orus.io/orus-io/rednerd
Vincent Hatakeyama's avatar
Vincent Hatakeyama committed
XCG Consulting, part of Orbeet_.

.. _Orbeet: https://orbeet.io/
Vincent Hatakeyama's avatar
Vincent Hatakeyama committed
.. _tutorials: https://orbeet.io/services/generateur-documents-redner/api-key/