README.md

   1 **IMPORTANT**: This file is in active development along with the policies in Firefox. To get the policy information that corresponds to a specific release, go to https://github.com/mozilla/policy-templates/releases.
   2
   3 Policies can either be specified using the Group Policy templates or by creating a file called `policies.json`. On Windows, create a directory called `distribution` where the EXE is located and place the file there. On Mac, the file goes into `Firefox.app/Contents/Resources/distribution`.  On Linux, the file goes into `firefox/distribution`, where `firefox` is the installation directory for firefox, which varies by distribution.
   4
   5 The content of the JSON file should look like this:
   6 ```
   7 {
   8   "policies": {
   9     ...POLICIES...
  10   }
  11 }
  12 ```
  13 Policies are documented below.
  14
  15
  16 **Note**: though comments are used in this readme file for documentation, comments are not valid in actual JSON files. Remove all comments before attempting to deploy.
  17
  18 Some of the policies were originally only available on the ESR for security reasons. As of Firefox 62, these policies are available outside of the ESR, but only via JSON file or a Local Machine-based Group Policy. User-based Group Policies are not allowed to set values for these policies. The descriptions below mark such policies as "Machine only".
  19
  20 ### Authentication
  21 This policy is for configuring sites that support integrated authentication. See https://developer.mozilla.org/en-US/docs/Mozilla/Integrated_authentication for more information.
  22 ```
  23 {
  24   "policies": {
  25     "Authentication": {
  26       "SPNEGO": ["mydomain.com", "https://myotherdomain.com"],
  27       "Delegated": ["mydomain.com", "https://myotherdomain.com"],
  28       "NTLM": ["mydomain.com", "https://myotherdomain.com"],
  29       "AllowNonFQDN": {
  30         "SPNEGO": true,
  31         "NTLM": true
  32       }
  33     }
  34   }
  35 }
  36 ```
  37 ### BlockAboutAddons
  38 This policy removes access to about:addons.
  39 ```
  40 {
  41   "policies": {
  42     "BlockAboutAddons": true
  43   }
  44 }
  45 ```
  46 ### BlockAboutConfig
  47 This policy removes access to about:config.
  48 ```
  49 {
  50   "policies": {
  51     "BlockAboutConfig": true
  52   }
  53 }
  54 ```
  55 ### BlockAboutProfiles
  56 This policy removes access to about:profiles.
  57 ```
  58 {
  59   "policies": {
  60     "BlockAboutProfiles": true
  61   }
  62 }
  63 ```
  64 ### BlockAboutSupport
  65 This policy removes access to about:support.
  66 ```
  67 {
  68   "policies": {
  69     "BlockAboutSupport": true
  70 }
  71 ```
  72 ### Bookmarks
  73 This policy allows you to specify bookmarks. You can have any number of bookmarks, although only ten are specified in the ADMX file.
  74 Placement can be specified as either toolbar or menu. If a folder is specified, it is automatically created and bookmarks with the
  75 same folder name are grouped together.
  76 ```
  77 {
  78   "policies": {
  79     "Bookmarks": [
  80       {
  81         "Title": "Example",
  82         "URL": "http://example.org",
  83         "Favicon": "http://example.com/favicon.ico",
  84         "Placement": ["toolbar", "menu"],
  85         "Folder": "FolderName"
  86       }
  87     ]
  88   }
  89 }
  90 ```
  91 ### Certificates
  92 If this policy is set to any value, Firefox reads certificates from the system certificate store. This is currently only supported on Windows, but will be available on macOS with Firefox 63.
  93 ```
  94 {
  95   "policies": {
  96     "Certificates": {
  97       "ImportEnterpriseRoots": true
  98     }
  99   }
 100 }
 101 ```
 102 ### Cookies
 103 This policy controls various settings related to cookies.
 104 ```
 105 {
 106   "policies": {
 107     "Cookies": {
 108       "Allow": ["http://example.org/"], /* Domains where cookies are always allowed */
 109       "Block": ["http://example.edu/"], /* Domains where cookies are always blocked */
 110       "Default": [true|false], /* This sets the default value for "Accept cookies from websites" */
 111       "AcceptThirdParty": ["always", "never", "from-visited"], /* This sets the default value for "Accept third-party cookies" */
 112       "ExpireAtSessionEnd":  [true|false], /* This determines when cookies expire */
 113       "Locked": [true|false] /* If this is true, cookies preferences can't be changed */
 114     }
 115   }
 116 }
 117 ```
 118 ### DNSOverHTTPS
 119 This policy configures DNS over HTTPS.
 120 ```
 121 {
 122   "policies": {
 123     "DNSOverHTTPS": {
 124       "Enabled": [true|false],
 125       "ProviderURL": "URL_TO_ALTERNATE_PROVIDER",
 126       "Locked": [true|false]
 127     }
 128   }
 129 }
 130 ```
 131 ### DisableSetDesktopBackground
 132 This policy removes the "Set As Desktop Background..." menuitem when right clicking on an image.
 133 ```
 134 {
 135   "policies": {
 136     "DisableSetDesktopBackground": true
 137   }
 138 }
 139 ```
 140 ### DisableMasterPasswordCreation
 141 If this policy is set to true, the master password functionality is removed.
 142 ```
 143 {
 144   "policies": {
 145     "DisableMasterPasswordCreation": [true|false]
 146   }
 147 }
 148 ```
 149 ### DisableAppUpdate (Machine only)
 150 This policy turns off application updates.
 151 ```
 152 {
 153   "policies": {
 154     "DisableAppUpdate": true
 155   }
 156 }
 157 ```
 158 ### DisableBuiltinPDFViewer
 159 This policy disables the built in PDF viewer. PDF files are downloaded and sent externally.
 160 ```
 161 {
 162   "policies": {
 163     "DisableBuiltinPDFViewer": true
 164   }
 165 }
 166 ```
 167 ### DisableDeveloperTools
 168 This policy removes access to all developer tools.
 169 ```
 170 {
 171   "policies": {
 172     "DisableDeveloperTools": true
 173   }
 174 }
 175 ```
 176 ### DisableFeedbackCommands
 177 This policy disables the menus for reporting sites (Submit Feedback, Report Deceptive Site).
 178 ```
 179 {
 180   "policies": {
 181     "DisableFeedbackCommands": true
 182   }
 183 }
 184 ```
 185 ### DisableFirefoxScreenshots
 186 This policy removes access to Firefox Screenshots.
 187 ```
 188 {
 189   "policies": {
 190     "DisableFirefoxScreenshots": true
 191   }
 192 }
 193 ```
 194 ### DisableFirefoxAccounts
 195 This policy disables Sync.
 196 ```
 197 {
 198   "policies": {
 199     "DisableFirefoxAccounts": true
 200   }
 201 }
 202 ```
 203 ### DisableFirefoxStudies
 204 This policy disables Firefox studies (Shield).
 205 ```
 206 {
 207   "policies": {
 208     "DisableFirefoxStudies": true
 209   }
 210 }
 211 ```
 212 ### DisableForgetButton
 213 This policy disables the "Forget" button.
 214 ```
 215 {
 216   "policies": {
 217     "DisableForgetButton": true
 218   }
 219 }
 220 ```
 221 ### DisableFormHistory
 222 This policy turns off the browser.formfill.enable preferences.
 223 ```
 224 {
 225   "policies": {
 226     "DisableFormHistory": true
 227   }
 228 }
 229 ```
 230 ### DisablePocket
 231 This policy turns off Pocket.
 232 ```
 233 {
 234   "policies": {
 235     "DisablePocket": true
 236   }
 237 }
 238 ```
 239 ### DisablePrivateBrowsing
 240 This policy removes access to private browsing.
 241 ```
 242 {
 243   "policies": {
 244     "DisablePrivateBrowsing": true
 245   }
 246 }
 247 ```
 248 ### DisableProfileImport
 249 This policy disables the "Import data from another browser" option in the bookmarks window.
 250 ```
 251 {
 252   "policies": {
 253     "DisableProfileImport": true
 254   }
 255 }
 256 ```
 257 ### DisableProfileRefresh
 258 This policy disables the Refresh Firefox button on about:support and support.mozilla.org.
 259 ```
 260 {
 261   "policies": {
 262     "DisableProfileRefresh": true
 263   }
 264 }
 265 ```
 266 ### DisableSafeMode
 267 This policy disables safe mode on Windows only.
 268 ```
 269 {
 270   "policies": {
 271     "DisableSafeMode": true
 272   }
 273 }
 274 ```
 275 ### DisableSecurityBypass
 276 This policy prevents the user from bypassing security in certain cases.
 277 ```
 278 {
 279   "policies": {
 280     "DisableSecurityBypass": {
 281       "InvalidCertificate": [true|false], /* Prevents adding an exception when an invalid certificate is shown */
 282       "SafeBrowsing": [true|false]        /* Prevents selecting "ignore the risk" and visiting a harmful site anyway */
 283     }
 284   }
 285 }
 286 ```
 287 ### DisableSystemAddonUpdate (Machine only)
 288 This policy prevents system add-ons from being updated or installed.
 289 ```
 290 {
 291   "policies": {
 292     "DisableSystemAddonUpdate": true
 293   }
 294 }
 295 ```
 296 ### DisableTelemetry (Machine only)
 297 This policy prevents the upload of telemetry data.
 298
 299 Mozilla recommends that you do not disable telemetry. Information collected through telemetry helps us build a better product for businesses like yours.
 300 ```
 301 {
 302   "policies": {
 303     "DisableTelemetry": true
 304   }
 305 }
 306 ```
 307 ### DisplayBookmarksToolbar
 308 This policy turns on the bookmarks toolbar by default. A user can still turn it off, and it will stay off.
 309 ```
 310 {
 311   "policies": {
 312     "DisplayBookmarksToolbar": true
 313   }
 314 }
 315 ```
 316 ### DisplayMenuBar
 317 This policy turns on the menubar by default. A user can still turn it off, and it will stay off.
 318 ```
 319 {
 320   "policies": {
 321     "DisplayMenuBar": true
 322   }
 323 }
 324 ```
 325 ### DontCheckDefaultBrowser
 326 This policy stops Firefox from checking if it is the default browser at startup.
 327 ```
 328 {
 329   "policies": {
 330     "DontCheckDefaultBrowser": true
 331   }
 332 }
 333 ```
 334 ### EnableTrackingProtection
 335 This policy affects tracking protection.
 336
 337 If this policy is not configured, tracking protection is not enabled by default in the browser, but it is enabled by default in private browsing and the user can change it.
 338
 339 If Value is set to false, tracking protection is disabled and locked in both the browser and private browsing.
 340
 341 If Value is set to true, tracking protection is enabled by default in both the browser and private browsing and you can choose set the Locked value if you want to prevent the user from changing it.
 342 ```
 343 {
 344   "policies": {
 345     "EnableTrackingProtection": {
 346       "Value": [true, false],
 347       "Locked": [true, false]
 348     }
 349 }
 350 ```
 351 ### Extensions (Machine only)
 352 This policy controls the installation, uninstallation and locking of extensions. Locked extensions cannot be disabled or uninstalled.
 353 For Install, you specify a list of URLs or paths.
 354 For Uninstall and Locked, you specify extension IDs.
 355 ```
 356 {
 357   "policies": {
 358     "Extensions": {
 359       "Install": ["https://addons.mozilla.org/firefox/downloads/somefile.xpi", "//path/to/xpi"],
 360       "Uninstall": ["addon_id@mozilla.org"],
 361       "Locked":  ["addon_id@mozilla.org"]
 362     }
 363 }
 364 ```
 365 ### HardwareAcceleration
 366 This policy disables hardware acceleration by locking the preference layers.acceleration.disabled to true.
 367 ```
 368 {
 369   "policies": {
 370     "HardwareAcceleration": false
 371   }
 372 }
 373 ```
 374 ### NoDefaultBookmarks
 375 This policy prevents the default bookmarks or the Smart Bookmarks (Most Visited, Recent Tags) from being created. Note: this policy is only effective if used before the first run of the profile.
 376 ```
 377 {
 378   "policies": {
 379     "NoDefaultBookmarks": true
 380   }
 381 }
 382 ```
 383 ### OfferToSaveLogins
 384 This policy sets the signon.rememberSignons preference. It determines whether or not Firefox offers to save passwords. It can either be enabled or disabled.
 385 ```
 386 {
 387   "policies": {
 388     "OfferToSaveLogins": true
 389   }
 390 }
 391 ```
 392 ### Homepage (Machine only)
 393 This policy sets the default homepage value. It can also be used to lock the homepage and add additional homepages.
 394 ```
 395 {
 396   "policies": {
 397     "Homepage": {
 398       "URL": "http://example.com/",
 399       "Locked": true,
 400       "Additional": ["http://example.org/",
 401                      "http://example.edu/"]
 402     }
 403   }
 404 }
 405 ```
 406 ### PopupBlocking
 407 This policy sets domains for which pop-up windows are allowed. It also sets the default pop-up policy.
 408 ```
 409 {
 410   "policies": {
 411     "PopupBlocking": {
 412       "Allow": ["http://example.org/",
 413                 "http://example.edu/"],
 414       "Default": [true|false], /* If this is set to false, pop-up window are enabled by default. */
 415       "Locked": [true|false]
 416     }
 417   }
 418 }
 419 ```
 420 ### InstallAddonsPermission
 421 This policy sets domains that can install extensions, as well as the default behavior.
 422 ```
 423 {
 424   "policies": {
 425     "InstallAddonsPermission": {
 426       "Allow": ["http://example.org/",
 427                 "http://example.edu/"],
 428       "Default": [true|false] /* If this is set to false, add-ons cannot be installed by the user */
 429     }
 430   }
 431 }
 432 ```
 433 ### FlashPlugin
 434 This policy sets the behavior of Flash on the specified domains, as well as the default behavior.
 435 ```
 436 {
 437   "policies": {
 438     "FlashPlugin": {
 439       "Allow": ["http://example.org/"], /* Sites on the allow list do not override Flash being completely disabled */
 440       "Block": ["http://example.edu/"],
 441       "Default": [true|false], /* If this is set to true, Flash is always enabled. If it is set to false, Flash is never enabled */
 442       "Locked": [true|false]
 443     }
 444   }
 445 }
 446 ```
 447 ### OverrideFirstRunPage (Machine only)
 448 This policy allows you to override the first run page. If you leave the URL blank, the first run page will not be displayed.
 449 ```
 450 {
 451   "policies": {
 452     "OverrideFirstRunPage": "http://example.org"
 453   }
 454 }
 455 ```
 456 ### OverridePostUpdatePage (Machine only)
 457 This policy allows you to override the upgrade page. If you leave the URL blank, the upgrade page will not be displayed.
 458 ```
 459 {
 460   "policies": {
 461     "OverridePostUpdatePage": "http://example.org"
 462   }
 463 }
 464 ```
 465 ### Permissions
 466 This policy allows you to change the permissions associated with camera, microphone, location, and notifications
 467 ```
 468 {
 469   "policies": {
 470     "Permissions": {
 471       "Camera": {
 472         "Allow": ["http://example.org/"], /* Origins where camera access is allowed by default */
 473         "Block": ["http://example.org/"], /* Origins where camera access is blocked by default */
 474         "BlockNewRequests": [true|false], /* Block new requests to access the camera */
 475         "Locked": [true|false] /* Don't allow the user to change the camera preferences */
 476       },
 477       "Microphone": {
 478         "Allow": ["http://example.org/"], /* Origins where microphone access is allowed by default */
 479         "Block": ["http://example.org/"], /* Origins where microphone access  is blocked by default */
 480         "BlockNewRequests": [true|false], /* Block new requests to access the microphone */
 481         "Locked": [true|false] /* Don't allow the user to change the microphone preferences */
 482       },
 483       "Location": {
 484         "Allow": ["http://example.org/"], /* Origins where location access is allowed by default */
 485         "Block": ["http://example.org/"], /* Origins where location access is blocked by default */
 486         "BlockNewRequests": [true|false], /* Block new requests to access location */
 487         "Locked": [true|false] /* Don't allow the user to change the location preferences */
 488       },
 489       "Notifications": {
 490         "Allow": ["http://example.org/"], /* Origins where sending notifications is allowed by default */
 491         "Block": ["http://example.org/"], /* Origins where sending notifications is blocked by default */
 492         "BlockNewRequests": [true|false], /* Block new requests to send notifications */
 493         "Locked": [true|false] /* Don't allow the user to change the notification preferences */
 494       }
 495     }
 496   }
 497 }
 498 ```
 499 ### Proxy
 500 This policy allows you to specify proxy settings. These settings correspond to the connection settings in Firefox preferences.
 501 To specify ports, append them to the hostnames with a colon (:). If Locked is set to true, the values can't be changed by the user.
 502 ```
 503 {
 504   "policies": {
 505     "Proxy": {
 506       "Mode": ["none", "system", "manual", "autoDetect", "autoConfig"],
 507       "Locked": [true, false],
 508       "HTTPProxy": "hostname",
 509       "UseHTTPProxyForAllProtocols": [true, false],
 510       "SSLProxy": "hostname",
 511       "FTPProxy": "hostname",
 512       "SOCKSProxy": "hostname",
 513       "SOCKSVersion": [4, 5],
 514       "Passthrough": "List of passthrough addresses/domains",
 515       "AutoConfigURL": "URL_TO_AUTOCONFIG",
 516       "AutoLogin":  [true, false],
 517       "UseProxyForDNS": [true, false]
 518     }
 519   }
 520 }
 521 ```
 522 ### RequestedLocales
 523 This policy sets the list of requested locales for the application in order of preference. It will cause the corresponding language pack to become active.
 524 ```
 525 {
 526   "policies": {
 527     "RequestedLocales": ["de", "en-US"]
 528   }
 529 }
 530 ```
 531 ### SanitizeOnShutdown
 532 If this policy is set to true,  all data is cleared when Firefox is closed. This includes Browsing & Download History, Cookies, Active Logins, Cache, Form & Search History, Site Preferences and Offline Website Data.
 533 ```
 534 {
 535   "policies": {
 536     "SanitizeOnShutdown": [true|false]
 537   }
 538 }
 539 ```
 540 ### SearchBar
 541 This policy can be used to determine if the search bar is separate or combined with the URL bar.
 542 ```
 543 {
 544   "policies": {
 545     "SearchBar": ["unified", "separate"]
 546   }
 547 }
 548 ```
 549 ### WebsiteFilter (Machine only)
 550 This policy blocks websites from being visited. The parameters take an array of Match Patterns, as documented in https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Match_patterns. Only http/https addresses are supported at the moment. The arrays are limited to 1000 entries each.
 551 ```
 552 {
 553   "policies": {
 554     "WebsiteFilter": {
 555       "Block": ["<all_urls>"],
 556       "Exceptions": ["http://example.org/*"]
 557     }
 558   }
 559 }
 560 ```
 561 ### Search Engines (This policy is only available on the ESR.)
 562 This policy allows you to add new search engines, remove or hide search engines, as well as set the default and prevent the install of search engines from web pages. Only Name and URLTemplate is required.
 563 ```
 564 {
 565   "policies": {
 566     "SearchEngines": {
 567       "Add": [
 568         {
 569           "Name": "",
 570           "URLTemplate": "URL including {searchTerms} to substitute for the terms",
 571           "Method": ["GET", "POST"],
 572           "IconURL": "URL to icon",
 573           "Alias": "Alias that can be used to access the engine",
 574           "Description": "Description",
 575           "SuggestURLTemplate": "URL for suggestions using {searchTerms}"
 576         }
 577       ],
 578       "Default": "Name of engine",
 579       "PreventInstalls": [true|false],
 580       "Remove": ["Twitter", "Wikipedia (en)"]
 581     }
 582   }
 583 }
 584 ```
 585 ### SecurityDevices
 586 This policy allows you to add PKCS #11 Modules
 587 ```
 588 {
 589   "policies": {
 590     "SecurityDevices": [
 591       "NAME_OF_DEVICE": "PATH_TO_LIBRARY_FOR_DEVICE"
 592     ]
 593   }
 594 }
 595 ```