Search Engine Indexing

By default, the documentation portal is automatically indexed by search engines. After each publication, the sitemap.xml and robots.txt files are updated. However, you can customize this behavior, such as hiding the portal from search engine indexing.

Index by Default

The documentation portal is indexed automatically unless otherwise specified.

Disable Indexing

To prevent the portal from being indexed, set the environment variable DISABLE_SEO: True during deployment.

If DISABLE_SEO is set to True but a robots.txt file exists on the server, the robots.txt file will take precedence.

Partial Indexing

  1. Create and configure a robots.txt file to control which parts of the portal are indexed.

  2. Place the robots.txt file in the same directory as the docker-compose.yaml file used for Gramax.

  3. Update the docker-compose.yaml file by adding the path to the robots.txt file in the volumes section:

    volumes: - ./robots.txt:/app/public/robots.txt

  4. Restart the Docker containers.