Download the PHP package fof/sitemap without Composer
On this page you can find all versions of the php package fof/sitemap. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package sitemap
SEO & Sitemap by FriendsOfFlarum
A comprehensive SEO solution for Flarum that provides both XML sitemaps and robots.txt generation to help search engines discover and index your forum content effectively.
Features
- XML Sitemaps: Automatically generated sitemaps with intelligent content discovery
- Robots.txt Generation: Standards-compliant robots.txt with dynamic path detection
- Search Engine Compliance: Ensures proper indexing while protecting sensitive areas
- Extensible Architecture: Other extensions can easily customize both sitemaps and robots.txt
- Performance Optimized: Multiple generation modes for forums of all sizes
- Smart Integration: Automatically detects and includes content from popular extensions
The extension intelligently includes content like Discussions, Users, Tags (flarum/tags), and Pages (fof/pages) while providing extensive customization options for developers.
Installation
This extension requires PHP 8.0 or greater.
Install manually with composer:
Updating
XML Sitemap Generation
The extension automatically generates XML sitemaps at /sitemap.xml that help search engines discover and index your forum content.
Generation Modes
There are two modes available, both serving content from your main domain for search engine compliance.
Runtime Mode
The sitemap is generated on-the-fly when requested. Individual sitemap files are served at /sitemap-1.xml, /sitemap-2.xml, etc.
Best for: Small to medium forums with less than 10,000 total items (discussions, users, tags, pages combined). Most shared hosting environments.
Cached Multi-File Mode
Sitemaps are pre-generated and updated via the Flarum scheduler. Content is stored on your configured storage (local disk, S3, CDN) but always served from your main domain.
Best for: Larger forums starting at 10,000+ items.
Manual rebuild:
Performance Optimizations
For enterprise customers with millions of items, the "Enable risky performance improvements" option reduces database response size by limiting returned columns. Only enable if generation takes over an hour or saturates your database connection.
Search Engine Compliance
The extension ensures full search engine compliance:
- Domain Consistency: All sitemaps served from your main forum domain
- Unified URLs: Consistent structure (
/sitemap.xml,/sitemap-1.xml) regardless of storage - Automatic Proxying: External storage content proxied through your domain
- Google Search Console Compatible: Works seamlessly with all major search engines
Scheduling
Cached sitemaps automatically update via the Flarum scheduler. Configure the frequency in extension settings.
Learn more about Flarum scheduler setup.
Robots.txt Generation
The extension automatically generates a standards-compliant robots.txt file at /robots.txt that works seamlessly with your sitemap configuration. It replaces any existing robots.txt functionality from other extensions like v17development/flarum-seo.
Features
- Dynamic Path Detection: Automatically detects admin, API, and forum paths from your Flarum configuration
- Settings Integration: Respects your sitemap exclusion settings (excludeUsers, excludeTags)
- Extensible System: Other extensions can easily add, remove, or modify robots.txt entries
- Standards Compliant: Generates proper robots.txt format with user-agent grouping
- Automatic Sitemap References: Includes your sitemap URL automatically
Default Behavior
The generated robots.txt includes:
Conditional entries (only included when relevant):
- User profiles (
/u/) - Disallowed whenexcludeUserssetting is enabled - Tag pages (
/t/and/tags) - Disallowed whenexcludeTagssetting is enabled and flarum/tags extension is installed
Integration with Sitemap Settings
The robots.txt generation automatically respects your sitemap configuration:
- When "Exclude users from sitemap" is enabled, user profile pages (
/u/) are disallowed - When "Exclude tags from sitemap" is enabled, tag pages (
/t/,/tags) are disallowed - The sitemap URL is automatically included based on your forum's URL configuration
This ensures consistency between what's in your sitemap and what's allowed in robots.txt.
Extending the Extension
This extension provides comprehensive APIs for customizing both XML sitemaps and robots.txt generation.
Extending XML Sitemaps
Using the Unified Sitemap Extender (Recommended)
The recommended way to extend sitemaps uses the unified Sitemap extender with method chaining:
Available Methods:
addResource(string $resourceClass): Add a custom resource to the sitemapremoveResource(string $resourceClass): Remove an existing resource from the sitemapreplaceResource(string $oldResourceClass, string $newResourceClass): Replace an existing resourceaddStaticUrl(string $routeName): Add a static URL by route nameforceCached(): Force cached mode for managed hosting environments
Creating Custom Resources
Create a class that extends FoF\Sitemap\Resources\Resource:
Extending Robots.txt
Using the Robots Extender
Extensions can customize robots.txt using the Robots extender:
Available Methods:
addEntry(string $entryClass): Add a custom robots.txt entryremoveEntry(string $entryClass): Remove an existing entryreplace(string $oldEntryClass, string $newEntryClass): Replace an existing entry
Creating Custom Robots Entries
Create a class that extends FoF\Sitemap\Robots\RobotsEntry:
Helper Methods Available:
disallowForAll(string $path),disallowFor(string $userAgent, string $path)allowForAll(string $path),allowFor(string $userAgent, string $path)crawlDelayForAll(int $seconds),crawlDelayFor(string $userAgent, int $seconds)sitemap(string $url)
Extending Default Entries
All default entries can be extended to modify their behavior:
Legacy Extenders (Deprecated)
The following extenders are deprecated and will be removed in Flarum 2.0:
Configuration Options
Sitemap Elements
Control which elements are included in your XML sitemaps:
- Include priority values: Used by some search engines like Bing and Yandex (ignored by Google)
- Include change frequency values: Helps search engines schedule crawling (ignored by Google)
Both are enabled by default. When enabled, the extension uses intelligent frequency calculation based on actual content activity.
Performance Settings
- Risky Performance Improvements: For enterprise customers with millions of items. Reduces database response size but may break custom visibility scopes or slug drivers.
Server Configuration
Nginx Configuration
If accessing /sitemap.xml or /robots.txt results in nginx 404 errors, add these rules:
Troubleshooting
Regenerating Sitemaps
If you've updated the extension or changed storage settings:
Debug Logging
When Flarum is in debug mode, the extension provides detailed logging for:
- Sitemap generation and serving
- Content proxying from external storage
- Route parameter extraction
- Request handling issues
Check your Flarum logs (storage/logs/) for detailed information.
Acknowledgments
The initial version of this extension was sponsored by profesionalreview.com.
