Search 1.9 billion lines of Odoo code on GitHub
document_ocr
<a class="reference external image-reference" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.svg">
</a>
<a name="ocr-for-documents"></a>
<h2>OCR for documents</h2>
<p>This module was written to make uploaded documents, for example scans, searchable by running OCR on them.</p>
<p>It supports all image formats <a class="reference external" href="http://pillow.readthedocs.io/en/3.2.x/handbook/image-file-formats.html">Pillow supports</a> for reading and PDFs.</p>
<a name="installation"></a>
<h3>Installation</h3>
<p>To install this module, you need to:</p>
<ol class="arabic simple">
<li>install tesseract and the language(s) your documents use</li>
<li>if you want to support OCR on PDFs, install imagemagick</li>
<li>install the module itself</li>
</ol>
<p>On an Debian or Ubuntu system you would typically run:</p>
<pre>
<code>$ sudo apt-get install tesseract-ocr imagemagick</code>
</pre>
<a name="configuration"></a>
<h3>Configuration</h3>
<p>To configure this module, go to:</p>
<ol class="arabic simple">
<li>Settings/Technical/Parameters/System parameters and review the parameters with names document_ocr.*</li>
</ol>
<a name="usage"></a>
<h3>Usage</h3>
<p>By default, character recognition is done asynchronously by a cronjob at night.
This is because the recognition process takes a while and you don't want to make your users wait for the indexation to finish.
The interval to run the cronjob can be adjusted to your needs in the <code>Scheduled Actions</code> menu, under ` <cite>Settings`</cite>.
In case you want to force the OCR to be done immediately, set configuration parameter <code>document_ocr.synchronous</code> to value <code>True</code>.</p>
<a class="reference external image-reference" href="https://runbot.odoo-community.org/runbot/118/8.0"><img alt="Try me on Runbot" src="https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas" /></a>
<a name="bug-tracker"></a>
<h3>Bug Tracker</h3>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/knowledge/issues">GitHub Issues</a>.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us smashing it by providing a detailed and welcomed feedback.</p>
<a name="credits"></a>
<h3>Credits</h3>
<a name="the-actual-work"></a>
<h4>The actual work</h4>
<ul class="simple">
<li><a class="reference external" href="https://github.com/tesseract-ocr">tesseract</a></li>
</ul>
<a name="images"></a>
<h4>Images</h4>
<ul class="simple">
<li>Odoo Community Association: <a class="reference external" href="https://github.com/OCA/maintainer-tools/blob/master/template/module/static/description/icon.svg">Icon</a>.</li>
</ul>
<a name="contributors"></a>
<h4>Contributors</h4>
<ul class="simple">
<li>Holger Brunn <<a class="reference external" href="mailto:hbrunn@therp.nl">hbrunn@therp.nl</a>></li>
</ul>
<p>Do not contact contributors directly about help with questions or problems concerning this addon, but use the <a class="reference external" href="mailto:community@mail.odoo.com">community mailing list</a> or the <a class="reference external" href="https://odoo-community.org/groups">appropriate specialized mailinglist</a> for help, and the bug tracker linked in <a class="reference internal" href="#bug-tracker">Bug Tracker</a> above for technical issues.</p>
<a name="maintainer"></a>
<h4>Maintainer</h4>
<a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a>
<p>This module is maintained by the OCA.</p>
<p>OCA, or the Odoo Community Association, is a nonprofit organization whose
mission is to support the collaborative development of Odoo features and
promote its widespread use.</p>
<p>To contribute to this module, please visit <a class="reference external" href="https://odoo-community.org">https://odoo-community.org</a>.</p>