Developer Documentation

SEO

The Altis SEO module is powered by Yoast SEO for its advanced features. The SEO module provides a suite of tools for enhancing and managing your network's visibility to search engines and social platforms including Facebook and Twitter.

Configuration

The following JSON is the default configuration for the module and can be overridden in your project's composer.json file.

{
	"extra": {
		"altis": {
			"modules": {
				"seo": {
					"enabled": true,
					"metadata": {
						"opengraph": true,
						"twitter": true,
						"fallback-image": false,
						"pinterest-verify": false,
						"social-urls": {
							"facebook": "",
							"twitter": "",
							"instagram": "",
							"linkedin": "",
							"myspace": "",
							"pinterest": "",
							"youtube": "",
							"wikipedia": ""
						},
						"opengraph-fallback": {
							"frontpage-title": "",
							"frontpage-desc": "",
							"frontpage-image": ""
						}
					},
					"redirects": true
				}
			}
		}
	}
}

Using Yoast SEO Premium

Yoast SEO Premium adds more features and access to Yoast's support team. Altis SEO is configured in such a way that if you own a copy of Yoast SEO Premium, all you need to do is install it as a composer dependency and it will work seamlessly without any additional configuration.

To install Yoast SEO Premium using Composer follow the instructions linked to in the Downloads section of MyYoast. You will be able to create a developer token and then be provided with the required composer.json updates and commands to run.

Note if you are using a headless architecture many of the features of Yoast SEO will not function as expected.

If you intend to install Yoast SEO Premium manually without using Composer, you will need to switch off the SEO module using the following configuration:

{
	"extra": {
		"altis": {
			"modules": {
				"seo": {
					"enabled": false
				}
			}
		}
	}
}