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 ### DisableSetDesktopBackground
 119 This policy removes the "Set As Desktop Background..." menuitem when right clicking on an image.
 120 ```
 121 {
 122   "policies": {
 123     "DisableSetDesktopBackground": true
 124   }
 125 }
 126 ```
 127 ### DisableMasterPasswordCreation
 128 If this policy is set to true, the master password functionality is removed.
 129 ```
 130 {
 131   "policies": {
 132     "DisableMasterPasswordCreation": [true|false]
 133   }
 134 }
 135 ```
 136 ### DisableAppUpdate (Machine only)
 137 This policy turns off application updates.
 138 ```
 139 {
 140   "policies": {
 141     "DisableAppUpdate": true
 142   }
 143 }
 144 ```
 145 ### DisableBuiltinPDFViewer
 146 This policy disables the built in PDF viewer. PDF files are downloaded and sent externally.
 147 ```
 148 {
 149   "policies": {
 150     "DisableBuiltinPDFViewer": true
 151   }
 152 }
 153 ```
 154 ### DisableDeveloperTools
 155 This policy removes access to all developer tools.
 156 ```
 157 {
 158   "policies": {
 159     "DisableDeveloperTools": true
 160   }
 161 }
 162 ```
 163 ### DisableFeedbackCommands
 164 This policy disables the menus for reporting sites (Submit Feedback, Report Deceptive Site).
 165 ```
 166 {
 167   "policies": {
 168     "DisableFeedbackCommands": true
 169   }
 170 }
 171 ```
 172 ### DisableFirefoxScreenshots
 173 This policy removes access to Firefox Screenshots.
 174 ```
 175 {
 176   "policies": {
 177     "DisableFirefoxScreenshots": true
 178   }
 179 }
 180 ```
 181 ### DisableFirefoxAccounts
 182 This policy disables Sync.
 183 ```
 184 {
 185   "policies": {
 186     "DisableFirefoxAccounts": true
 187   }
 188 }
 189 ```
 190 ### DisableFirefoxStudies
 191 This policy disables Firefox studies (Shield).
 192 ```
 193 {
 194   "policies": {
 195     "DisableFirefoxStudies": true
 196   }
 197 }
 198 ```
 199 ### DisableForgetButton
 200 This policy disables the "Forget" button.
 201 ```
 202 {
 203   "policies": {
 204     "DisableForgetButton": true
 205   }
 206 }
 207 ```
 208 ### DisableFormHistory
 209 This policy turns off the browser.formfill.enable preferences.
 210 ```
 211 {
 212   "policies": {
 213     "DisableFormHistory": true
 214   }
 215 }
 216 ```
 217 ### DisablePocket
 218 This policy turns off Pocket.
 219 ```
 220 {
 221   "policies": {
 222     "DisablePocket": true
 223   }
 224 }
 225 ```
 226 ### DisablePrivateBrowsing
 227 This policy removes access to private browsing.
 228 ```
 229 {
 230   "policies": {
 231     "DisablePrivateBrowsing": true
 232   }
 233 }
 234 ```
 235 ### DisableProfileImport
 236 This policy disables the "Import data from another browser" option in the bookmarks window.
 237 ```
 238 {
 239   "policies": {
 240     "DisableProfileImport": true
 241   }
 242 }
 243 ```
 244 ### DisableProfileRefresh
 245 This policy disables the Refresh Firefox button on about:support and support.mozilla.org.
 246 ```
 247 {
 248   "policies": {
 249     "DisableProfileRefresh": true
 250   }
 251 }
 252 ```
 253 ### DisableSafeMode
 254 This policy disables safe mode on Windows only.
 255 ```
 256 {
 257   "policies": {
 258     "DisableSafeMode": true
 259   }
 260 }
 261 ```
 262 ### DisableSecurityBypass
 263 This policy prevents the user from bypassing security in certain cases.
 264 ```
 265 {
 266   "policies": {
 267     "DisableSecurityBypass": {
 268       "InvalidCertificate": [true|false], /* Prevents adding an exception when an invalid certificate is shown */
 269       "SafeBrowsing": [true|false]        /* Prevents selecting "ignore the risk" and visiting a harmful site anyway */
 270     }
 271   }
 272 }
 273 ```
 274 ### DisableSystemAddonUpdate (Machine only)
 275 This policy prevents system add-ons from being updated or installed.
 276 ```
 277 {
 278   "policies": {
 279     "DisableSystemAddonUpdate": true
 280   }
 281 }
 282 ```
 283 ### DisableTelemetry (Machine only)
 284 This policy prevents the upload of telemetry data.
 285
 286 Mozilla recommends that you do not disable telemetry. Information collected through telemetry helps us build a better product for businesses like yours.
 287 ```
 288 {
 289   "policies": {
 290     "DisableTelemetry": true
 291   }
 292 }
 293 ```
 294 ### DisplayBookmarksToolbar
 295 This policy turns on the bookmarks toolbar by default. A user can still turn it off, and it will stay off.
 296 ```
 297 {
 298   "policies": {
 299     "DisplayBookmarksToolbar": true
 300   }
 301 }
 302 ```
 303 ### DisplayMenuBar
 304 This policy turns on the menubar by default. A user can still turn it off, and it will stay off.
 305 ```
 306 {
 307   "policies": {
 308     "DisplayMenuBar": true
 309   }
 310 }
 311 ```
 312 ### DontCheckDefaultBrowser
 313 This policy stops Firefox from checking if it is the default browser at startup.
 314 ```
 315 {
 316   "policies": {
 317     "DontCheckDefaultBrowser": true
 318   }
 319 }
 320 ```
 321 ### EnableTrackingProtection
 322 This policy affects tracking protection.
 323
 324 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.
 325
 326 If Value is set to false, tracking protection is disabled and locked in both the browser and private browsing.
 327
 328 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.
 329 ```
 330 {
 331   "policies": {
 332     "EnableTrackingProtection": {
 333       "Value": [true, false],
 334       "Locked": [true, false]
 335     }
 336 }
 337 ```
 338 ### Extensions (Machine only)
 339 This policy controls the installation, uninstallation and locking of extensions. Locked extensions cannot be disabled or uninstalled.
 340 For Install, you specify a list of URLs or paths.
 341 For Uninstall and Locked, you specify extension IDs.
 342 ```
 343 {
 344   "policies": {
 345     "Extensions": {
 346       "Install": ["https://addons.mozilla.org/firefox/downloads/somefile.xpi", "//path/to/xpi"],
 347       "Uninstall": ["addon_id@mozilla.org"],
 348       "Locked":  ["addon_id@mozilla.org"]
 349     }
 350 }
 351 ```
 352 ### HardwareAcceleration
 353 This policy disables hardware acceleration by locking the preference layers.acceleration.disabled to true.
 354 ```
 355 {
 356   "policies": {
 357     "HardwareAcceleration": false
 358   }
 359 }
 360 ```
 361 ### NoDefaultBookmarks
 362 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.
 363 ```
 364 {
 365   "policies": {
 366     "NoDefaultBookmarks": true
 367   }
 368 }
 369 ```
 370 ### OfferToSaveLogins
 371 This policy sets the signon.rememberSignons preference. It determines whether or not Firefox offers to save passwords. It can either be enabled or disabled.
 372 ```
 373 {
 374   "policies": {
 375     "OfferToSaveLogins": true
 376   }
 377 }
 378 ```
 379 ### Homepage (Machine only)
 380 This policy sets the default homepage value. It can also be used to lock the homepage and add additional homepages.
 381 ```
 382 {
 383   "policies": {
 384     "Homepage": {
 385       "URL": "http://example.com/",
 386       "Locked": true,
 387       "Additional": ["http://example.org/",
 388                      "http://example.edu/"]
 389     }
 390   }
 391 }
 392 ```
 393 ### PopupBlocking
 394 This policy sets domains for which pop-up windows are allowed. It also sets the default pop-up policy.
 395 ```
 396 {
 397   "policies": {
 398     "PopupBlocking": {
 399       "Allow": ["http://example.org/",
 400                 "http://example.edu/"],
 401       "Default": [true|false], /* If this is set to false, pop-up window are enabled by default. */
 402       "Locked": [true|false]
 403     }
 404   }
 405 }
 406 ```
 407 ### InstallAddonsPermission
 408 This policy sets domains that can install extensions, as well as the default behavior.
 409 ```
 410 {
 411   "policies": {
 412     "InstallAddonsPermission": {
 413       "Allow": ["http://example.org/",
 414                 "http://example.edu/"],
 415       "Default": [true|false] /* If this is set to false, add-ons cannot be installed by the user */
 416     }
 417   }
 418 }
 419 ```
 420 ### FlashPlugin
 421 This policy sets the behavior of Flash on the specified domains, as well as the default behavior.
 422 ```
 423 {
 424   "policies": {
 425     "FlashPlugin": {
 426       "Allow": ["http://example.org/"], /* Sites on the allow list do not override Flash being completely disabled */
 427       "Block": ["http://example.edu/"],
 428       "Default": [true|false], /* If this is set to true, Flash is always enabled. If it is set to false, Flash is never enabled */
 429       "Locked": [true|false]
 430     }
 431   }
 432 }
 433 ```
 434 ### OverrideFirstRunPage (Machine only)
 435 This policy allows you to override the first run page. If you leave the URL blank, the first run page will not be displayed.
 436 ```
 437 {
 438   "policies": {
 439     "OverrideFirstRunPage": "http://example.org"
 440   }
 441 }
 442 ```
 443 ### OverridePostUpdatePage (Machine only)
 444 This policy allows you to override the upgrade page. If you leave the URL blank, the upgrade page will not be displayed.
 445 ```
 446 {
 447   "policies": {
 448     "OverridePostUpdatePage": "http://example.org"
 449   }
 450 }
 451 ```
 452 ### Permissions
 453 This policy allows you to change the permissions associated with camera, microphone, location, and notifications
 454 ```
 455 {
 456   "policies": {
 457     "Permissions": {
 458       "Camera": {
 459         "Allow": ["http://example.org/"], /* Origins where camera access is allowed by default */
 460         "Block": ["http://example.org/"], /* Origins where camera access is blocked by default */
 461         "BlockNewRequests": [true|false], /* Block new requests to access the camera */
 462         "Locked": [true|false] /* Don't allow the user to change the camera preferences */
 463       },
 464       "Microphone": {
 465         "Allow": ["http://example.org/"], /* Origins where microphone access is allowed by default */
 466         "Block": ["http://example.org/"], /* Origins where microphone access  is blocked by default */
 467         "BlockNewRequests": [true|false], /* Block new requests to access the microphone */
 468         "Locked": [true|false] /* Don't allow the user to change the microphone preferences */
 469       },
 470       "Location": {
 471         "Allow": ["http://example.org/"], /* Origins where location access is allowed by default */
 472         "Block": ["http://example.org/"], /* Origins where location access is blocked by default */
 473         "BlockNewRequests": [true|false], /* Block new requests to access location */
 474         "Locked": [true|false] /* Don't allow the user to change the location preferences */
 475       },
 476       "Notifications": {
 477         "Allow": ["http://example.org/"], /* Origins where sending notifications is allowed by default */
 478         "Block": ["http://example.org/"], /* Origins where sending notifications is blocked by default */
 479         "BlockNewRequests": [true|false], /* Block new requests to send notifications */
 480         "Locked": [true|false] /* Don't allow the user to change the notification preferences */
 481       }
 482     }
 483   }
 484 }
 485 ```
 486 ### Proxy
 487 This policy allows you to specify proxy settings. These settings correspond to the connection settings in Firefox preferences.
 488 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.
 489 ```
 490 {
 491   "policies": {
 492     "Proxy": {
 493       "Mode": ["none", "system", "manual", "autoDetect", "autoConfig"],
 494       "Locked": [true, false],
 495       "HTTPProxy": "hostname",
 496       "UseHTTPProxyForAllProtocols": [true, false],
 497       "SSLProxy": "hostname",
 498       "FTPProxy": "hostname",
 499       "SOCKSProxy": "hostname",
 500       "SOCKSVersion": [4, 5],
 501       "Passthrough": "List of passthrough addresses/domains",
 502       "AutoConfigURL": "URL_TO_AUTOCONFIG",
 503       "AutoLogin":  [true, false],
 504       "UseProxyForDNS": [true, false]
 505     }
 506   }
 507 }
 508 ```
 509 ### RequestedLocales
 510 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.
 511 ```
 512 {
 513   "policies": {
 514     "RequestedLocales": ["de", "en-US"]
 515   }
 516 }
 517 ```
 518 ### SanitizeOnShutdown
 519 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.
 520 ```
 521 {
 522   "policies": {
 523     "SanitizeOnShutdown": [true|false]
 524   }
 525 }
 526 ```
 527 ### SearchBar
 528 This policy can be used to determine if the search bar is separate or combined with the URL bar.
 529 ```
 530 {
 531   "policies": {
 532     "SearchBar": ["unified", "separate"]
 533   }
 534 }
 535 ```
 536 ### WebsiteFilter (Machine only)
 537 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.
 538 ```
 539 {
 540   "policies": {
 541     "WebsiteFilter": {
 542       "Block": ["<all_urls>"],
 543       "Exceptions": ["http://example.org/*"]
 544     }
 545   }
 546 }
 547 ```
 548 ### Search Engines (This policy is only available on the ESR.)
 549 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.
 550 ```
 551 {
 552   "policies": {
 553     "SearchEngines": {
 554       "Add": [
 555         {
 556           "Name": "",
 557           "URLTemplate": "URL including {searchTerms} to substitute for the terms",
 558           "Method": ["GET", "POST"],
 559           "IconURL": "URL to icon",
 560           "Alias": "Alias that can be used to access the engine",
 561           "Description": "Description",
 562           "SuggestURLTemplate": "URL for suggestions using {searchTerms}"
 563         }
 564       ],
 565       "Default": "Name of engine",
 566       "PreventInstalls": [true|false],
 567       "Remove": ["Twitter", "Wikipedia (en)"]
 568     }
 569   }
 570 }
 571 ```
 572 ### SecurityDevices
 573 This policy allows you to add PKCS #11 Modules
 574 ```
 575 {
 576   "policies": {
 577     "SecurityDevices": [
 578       "NAME_OF_DEVICE": "PATH_TO_LIBRARY_FOR_DEVICE"
 579     ]
 580   }
 581 }
 582 ```