/
config.php
173 lines (132 loc) · 5.97 KB
/
config.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
<?php
/**
* SEOmatic plugin for Craft CMS
*
* A turnkey SEO implementation for Craft CMS that is comprehensive, powerful,
* and flexible
*
* @link https://nystudio107.com
* @copyright Copyright (c) 2017 nystudio107
*/
/**
* @author nystudio107
* @package Seomatic
* @since 3.0.0
*/
/**
* SEOmatic config.php
*
* This file exists only as a template for the SEOmatic settings.
* It does nothing on its own.
*
* Don't edit this file, instead copy it to 'craft/config' as 'seomatic.php'
* and make your changes there to override default settings.
*
* Once copied to 'craft/config', this file will be multi-environment aware as
* well, so you can have different settings groups for each environment, just as
* you do for 'general.php'
*/
return [
// The public-facing name of the plugin
'pluginName' => 'SEOmatic',
// Should SEOmatic render metadata?
'renderEnabled' => true,
// Should SEOmatic render frontend sitemaps?
'sitemapsEnabled' => true,
// Should sitemaps be regenerated automatically?
'regenerateSitemapsAutomatically' => true,
// Should sitemaps be submitted to search engines automatically whenever there are changes?
'submitSitemaps' => true,
// Should items where the entry URL doesn't match the canonical URL be excluded?
'excludeNonCanonicalUrls' => false,
// Should the homepage be included in the generated Breadcrumbs JSON-LD?
'includeHomepageInBreadcrumbs' => true,
// Should SEOmatic add to the http response headers?
'headersEnabled' => true,
// Whether the environment should be manually set, or automatically determined
'manuallySetEnvironment' => false,
// The server environment, either `live`, `staging`, or `local`
'environment' => 'live',
// Should SEOmatic display the SEO Preview sidebar?
'displayPreviewSidebar' => true,
// Should SEOmatic add a Social Media Preview Target?
'socialMediaPreviewTarget' => true,
// The social media platforms that should be displayed in the SEO Preview sidebar
'sidebarDisplayPreviewTypes' => [
'google',
'twitter',
'facebook',
],
// Should SEOmatic display the SEO Analysis sidebar?
'displayAnalysisSidebar' => true,
// If `devMode` is on, prefix the <title> with this string
'devModeTitlePrefix' => '🚧 ',
// Prefix the Control Panel <title> with this string
'cpTitlePrefix' => '⚙ ',
// If `devMode` is on, prefix the Control Panel <title> with this string
'devModeCpTitlePrefix' => '🚧⚙ ',
// The separator character to use for the `<title>` tag
'separatorChar' => '|',
// The max number of characters in the `<title>` tag
'maxTitleLength' => 70,
// The max number of characters in the `<meta name="description">` tag
'maxDescriptionLength' => 155,
// Should Title tags be truncated at the max length, on word boundaries?
'truncateTitleTags' => true,
// Should Description tags be truncated at the max length, on word boundaries?
'truncateDescriptionTags' => true,
// Site Groups define logically separate sites
'siteGroupsSeparate' => true,
// Whether to dynamically include the hreflang tags
'addHrefLang' => true,
// Whether to dynamically include the `x-default` hreflang tags
'addXDefaultHrefLang' => true,
// Whether to dynamically include hreflang tags on paginated pages
'addPaginatedHreflang' => true,
// Whether to include a Content Security Policy "nonce" for inline
// CSS or JavaScript. Valid values are 'header' or 'tag' for how the CSP
// should be included. c.f.:
// https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/script-src#Unsafe_inline_script
'cspNonce' => '',
// Fixed Content Security Policies to be added before any CSP nonces
'cspScriptSrcPolicies' => [
0 => [
'policy' => "'self'",
],
],
// SEO [best practices](https://www.searchenginejournal.com/google-dont-mix-noindex-relcanonical/262607)
// are to have `canonical` links not appear on pages that are not intended to be indexed. SEOmatic does
// this for you by default, but you can override that behavior with this setting
'alwaysIncludeCanonicalUrls' => false,
// Should the Canonical URL be automatically lower-cased?
'lowercaseCanonicalUrl' => true,
// Should the meta generator tag and X-Powered-By header be included?
'generatorEnabled' => true,
// SEOmatic uses the Craft `siteUrl` to generate the external URLs. If you
// are using it in a non-standard environment, such as a headless GraphQL or
// ElementAPI server, you can override what it uses for the `siteUrl` below.
// This can be either a simple string, or an array of strings indexed by the site
// handle, for multi-site setups. e.g.:
// 'siteUrlOverride' => [
// 'default' => 'http://example.com/',
// 'spanish' => 'http://example.com/es/',
// ],
'siteUrlOverride' => '',
// The duration of the SEOmatic meta cache in seconds. Null means always cached until explicitly broken
// If devMode is on, caches last 30 seconds.
'metaCacheDuration' => null,
// Determines whether the meta container endpoint should be enabled for anonymous frontend access
'enableMetaContainerEndpoint' => false,
// Determines whether the JSON-LD endpoint should be enabled for anonymous frontend access
'enableJsonLdEndpoint' => false,
// Determines whether the SEO File Link endpoint should be enabled for anonymous frontend access
'enableSeoFileLinkEndpoint' => false,
// Determines whether the SEOmatic debug toolbar panel should be added to the Yii2 debug toolbar
'enableDebugToolbarPanel' => true,
// SeoElementInterface[] The default SeoElement type classes
'defaultSeoElementTypes' => [
],
// string[] URL params that are allowed to be considered part of the unique URL used for the metadata cache
'allowedUrlParams' => [
],
];