README

Sitemap for Waterhole

A comprehensive, high-performance XML sitemap generator for Waterhole. This extension automatically generates SEO-compliant sitemaps for your community, helping search engines (Google, Bing...) discover and index your content faster.

🚀 Features

Zero configuration: Works out of the box.
Performance: 24-hour caching prevents database load, even with thousands of posts.
Segmented sitemaps: Separate endpoints for Posts, Channels, Pages, and Users.
SEO optimized: Includes lastmod, changefreq, and priority tags.
Safe: Read-only operation. Does not modify your database.

📦 Installation

Install via Composer. Run the following command in your Waterhole root directory:

composer require flectar/waterhole-sitemap

♻️ Updating

To update the extension, simply run:

composer update flectar/waterhole-sitemap:"*"
php artisan cache:clear

⚙️ Usage

Once installed, the sitemap is automatically available at:

https://your-domain.com/sitemap (Index)
https://your-domain.com/sitemap/posts
https://your-domain.com/sitemap/channels
https://your-domain.com/sitemap/users

Robots.txt To ensure search engines find your sitemap, add the following line to your public/robots.txt:

Sitemap: https://your-domain.com/sitemap

🔧 Configuration

The sitemap is cached for 24 hours by default to ensure optimal performance. To force a refresh (e.g., after a large content import), run:

php artisan optimize
php artisan cache:clear

📄 License

Open-sourced under the MIT License.

flectar / waterhole-sitemap

Maintainers

Package info

Statistics

Security