<h1 class="title">website_no_index</h1>
<p><a class="reference external" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external" 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.png" /></a> <a class="reference external" href="https://github.com/OCA/website/tree/11.0/website_no_index"><img alt="OCA/website" src="https://img.shields.io/badge/github-OCA%2Fwebsite-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/website-11-0/website-11-0-website_no_index"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external" href="https://runbot.odoo-community.org/runbot/186/11.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p>
<p>By default, /robots.txt on an Odoo installation with website module installed will allow indexing by webcrawlers.</p>
<p>This module will read the noindex parameter on the http.route decorator to generate a /robots.txt.</p>
<p><strong>Table of contents</strong></p>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><a class="reference internal" href="#usage" id="id1">Usage</a></li>
<li><a class="reference internal" href="#known-issues-roadmap" id="id2">Known issues / Roadmap</a></li>
<li><a class="reference internal" href="#bug-tracker" id="id3">Bug Tracker</a></li>
<li><a class="reference internal" href="#credits" id="id4">Credits</a><ul>
<li><a class="reference internal" href="#authors" id="id5">Authors</a></li>
<li><a class="reference internal" href="#contributors" id="id6">Contributors</a></li>
<li><a class="reference internal" href="#maintainers" id="id7">Maintainers</a></li>
</ul>
</li>
</ul>
</div>
<a name="usage"></a>
<h2><a class="toc-backref" href="#id1">Usage</a></h2>
<p>For each http.route which should not be indexed, add the parameter <code>"noindex"</code> to the
route decorator.</p>
<p>The value of the parameter is a list of strings. The following values are used:</p>
<ul class="simple">
<li><code>"meta"</code> add the tag <meta name="robots" content="noindex"/> to an html page
(based on website.layout).</li>
<li><code>"header"</code> add the header 'X-Robots-Tag: noindex' to the http response.</li>
<li><code>"robots"</code> signals the robots.txt generator that the route should not be crawled.</li>
</ul>
<pre>
<code lang="python">@http.route(['/example_1'], type='http', auth="public", noindex=['robots'])
def route_controller_1(self):
pass
@http.route(['/example_2'], type='http', auth="public",
noindex=['robots', 'meta', 'header'])
def route_controller_2(self):
pass</code>
</pre>
<a name="known-issues-roadmap"></a>
<h2><a class="toc-backref" href="#id2">Known issues / Roadmap</a></h2>
<ul class="simple">
<li>When two endpoints are resolved to the same wildcard URL, only the noindex
information of the last endpoint parsed is used.</li>
<li>Does not do any special works for multilang website.</li>
</ul>
<a name="bug-tracker"></a>
<h2><a class="toc-backref" href="#id3">Bug Tracker</a></h2>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/website/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
<a class="reference external" href="https://github.com/OCA/website/issues/new?body=module:%20website_no_index%0Aversion:%2011.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
<p>Do not contact contributors directly about support or help with technical issues.</p>
<a name="credits"></a>
<h2><a class="toc-backref" href="#id4">Credits</a></h2>
<a name="authors"></a>
<h3><a class="toc-backref" href="#id5">Authors</a></h3>
<ul class="simple">
<li>Compassion CH</li>
</ul>
<a name="contributors"></a>
<h3><a class="toc-backref" href="#id6">Contributors</a></h3>
<ul class="simple">
<li>Christopher Meier <<a class="reference external" href="mailto:dev@c-meier.ch">dev@c-meier.ch</a>></li>
</ul>
<a name="maintainers"></a>
<h3><a class="toc-backref" href="#id7">Maintainers</a></h3>
<p>This module is maintained by Compassion Switzerland.</p>
<a class="reference external image-reference" href="https://www.compassion.ch"><img alt="Compassion Switzerland" src="https://upload.wikimedia.org/wikipedia/en/8/83/CompassionInternationalLogo.png" /></a>
<p>Compassion Switzerland is a nonprofit organization whose
mission is to release children from extreme poverty in Jesus name.</p>
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/website/tree/11.0/website_no_index">OCA/website</a> project on GitHub.</p>
<p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>