PHPackages                             bnomei/kirby3-robots-txt - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. bnomei/kirby3-robots-txt

ActiveKirby-plugin

bnomei/kirby3-robots-txt
========================

Manage a virtual robots.txt from the Kirby config file

5.1.0(1y ago)2148.9k↓26.5%[1 PRs](https://github.com/bnomei/kirby3-robots-txt/pulls)MITPHPPHP >=8.2.0CI passing

Since Oct 5Pushed 1y ago1 watchersCompare

[ Source](https://github.com/bnomei/kirby3-robots-txt)[ Packagist](https://packagist.org/packages/bnomei/kirby3-robots-txt)[ RSS](/packages/bnomei-kirby3-robots-txt/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (10)Dependencies (6)Versions (29)Used By (0)

Kirby Robots.txt
================

[](#kirby-robotstxt)

[![Kirby 5](https://camo.githubusercontent.com/b1a1b2ccd58e96259a9722c2489d91f40378c01b6c4c3e9fd27ed1d12c269d7c/68747470733a2f2f666c61742e62616467656e2e6e65742f62616467652f4b697262792f353f636f6c6f723d454343373438)](https://getkirby.com)[![PHP 8.2](https://camo.githubusercontent.com/fd050028b4459f3f6e4db5703412957375ceb180d27951213d421eb2a23c8c8e/68747470733a2f2f666c61742e62616467656e2e6e65742f62616467652f5048502f382e323f636f6c6f723d3445354239332669636f6e3d706870266c6162656c)](https://camo.githubusercontent.com/fd050028b4459f3f6e4db5703412957375ceb180d27951213d421eb2a23c8c8e/68747470733a2f2f666c61742e62616467656e2e6e65742f62616467652f5048502f382e323f636f6c6f723d3445354239332669636f6e3d706870266c6162656c)[![Release](https://camo.githubusercontent.com/7c87c2fbbf8c69ab8e463baa4b26dcc15b634de63ddff64724bf379043555b20/68747470733a2f2f666c61742e62616467656e2e6e65742f7061636b61676973742f762f626e6f6d65692f6b69726279332d726f626f74732d7478743f636f6c6f723d6165383166662669636f6e3d676974687562266c6162656c)](https://camo.githubusercontent.com/7c87c2fbbf8c69ab8e463baa4b26dcc15b634de63ddff64724bf379043555b20/68747470733a2f2f666c61742e62616467656e2e6e65742f7061636b61676973742f762f626e6f6d65692f6b69726279332d726f626f74732d7478743f636f6c6f723d6165383166662669636f6e3d676974687562266c6162656c)[![Downloads](https://camo.githubusercontent.com/b053ef45f0265acc4e112b4df4447810e02555f9abba336392a866754322fde5/68747470733a2f2f666c61742e62616467656e2e6e65742f7061636b61676973742f64742f626e6f6d65692f6b69726279332d726f626f74732d7478743f636f6c6f723d3237323832322669636f6e3d676974687562266c6162656c)](https://camo.githubusercontent.com/b053ef45f0265acc4e112b4df4447810e02555f9abba336392a866754322fde5/68747470733a2f2f666c61742e62616467656e2e6e65742f7061636b61676973742f64742f626e6f6d65692f6b69726279332d726f626f74732d7478743f636f6c6f723d3237323832322669636f6e3d676974687562266c6162656c)[![Coverage](https://camo.githubusercontent.com/b8ddbf1a4a6d6dd7042d73aa9b2a501b4d86e24e6b2136561d9cb855f88a8a51/68747470733a2f2f666c61742e62616467656e2e6e65742f636f6465636c696d6174652f636f7665726167652f626e6f6d65692f6b69726279332d726f626f74732d7478743f69636f6e3d636f6465636c696d617465266c6162656c)](https://codeclimate.com/github/bnomei/kirby3-robots-txt)[![Maintainability](https://camo.githubusercontent.com/2d6b6979dec5bdaca1c04b7037f506625933e0c7482e5a301d927cf34f856bbd/68747470733a2f2f666c61742e62616467656e2e6e65742f636f6465636c696d6174652f6d61696e7461696e6162696c6974792f626e6f6d65692f6b69726279332d726f626f74732d7478743f69636f6e3d636f6465636c696d617465266c6162656c)](https://codeclimate.com/github/bnomei/kirby3-robots-txt/issues)[![Discord](https://camo.githubusercontent.com/36eaef1b06f4996feb7587aa3281dcbd658e57535bc6b5e10110ed108e7a7a03/68747470733a2f2f666c61742e62616467656e2e6e65742f62616467652f646973636f72642f626e6f6d65693f636f6c6f723d3732383964612669636f6e3d646973636f7264266c6162656c)](https://discordapp.com/users/bnomei)[![Buymecoffee](https://camo.githubusercontent.com/62e55d1129b82bf9c2fd4656451e81ab87a9787e7c9676ca58276532ed9666ee/68747470733a2f2f666c61742e62616467656e2e6e65742f62616467652f69636f6e2f646f6e6174653f69636f6e3d6275796d6561636f6666656526636f6c6f723d464638313346266c6162656c)](https://www.buymeacoffee.com/bnomei)

Installing the plugin is enough to get a virtual [robots.txt](https://developers.google.com/search/reference/robots_txt) file.

Installation
------------

[](#installation)

- unzip [master.zip](https://github.com/bnomei/kirby3-robots-txt/archive/master.zip) as folder `site/plugins/kirby3-robots-txt` or
- `git submodule add https://github.com/bnomei/kirby3-robots-txt.git site/plugins/kirby3-robots-txt` or
- `composer require bnomei/kirby3-robots-txt`

Zero-Configuration
------------------

[](#zero-configuration)

The plugin will work out of the box without the need to configure anything. It will generate a virtual `robots.txt` file with the following content.

```
User-agent: *
Disallow: /kirby/
Disallow: /site/
Disallow: /cdn-cgi/
Allow: /media/
```

Active debug mode will block indexing by search engines
-------------------------------------------------------

[](#active-debug-mode-will-block-indexing-by-search-engines)

Warning

Setting the global Kirby `debug` configuration to `true` will prevent all indexing for every user agent (all Search Engines).

Link to Sitemap.xml
-------------------

[](#link-to-sitemapxml)

This plugin will add the link to your `sitemap.xml` **automatically** for most available SEO plugins. In that case, you can skip setting the `bnomei.robots-txt.sitemap` config value to `sitemap.xml`.

Optional Manual Configuration
-----------------------------

[](#optional-manual-configuration)

The plugin generates automatic defaults optimized for the official [Kirby Starterkit](https://github.com/getkirby/starterkit). You do not have to enter any of them in the config file. But if you would, they would look like this.

**defaults for Kirby Starterkit**

```