README-new.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 be specified using the Group Policy templates on Windows (https://github.com/mozilla/policy-templates/tree/master/windows), configuration profiles on macOS (https://github.com/mozilla/policy-templates/tree/master/mac), 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 ### AppUpdateURL
  19 This policy is for changing the URL used for application update
  20 ```
  21 {
  22   "AppUpdateURL": "http://yoursite.com"
  23 }
  24 ```
  25
  26
  27 ### Authentication
  28 This policy is for configuring sites that support integrated authentication. See https://developer.mozilla.org/en-US/docs/Mozilla/Integrated_authentication for more information.
  29 ```
  30 {
  31   "policies": {
  32     "Authentication": {
  33       "SPNEGO": ["mydomain.com", "https://myotherdomain.com"],
  34       "Delegated": ["mydomain.com", "https://myotherdomain.com"],
  35       "NTLM": ["mydomain.com", "https://myotherdomain.com"],
  36       "AllowNonFQDN": {
  37         "SPNEGO": true,
  38         "NTLM": true
  39       }
  40     }
  41   }
  42 }
  43 ```
  44 ### BlockAboutAddons
  45 This policy removes access to about:addons.
  46 ```
  47 {
  48   "policies": {
  49     "BlockAboutAddons": true
  50   }
  51 }
  52 ```
  53 ### BlockAboutConfig
  54 This policy removes access to about:config.
  55 ```
  56 {
  57   "policies": {
  58     "BlockAboutConfig": true
  59   }
  60 }
  61 ```
  62 ### BlockAboutProfiles
  63 This policy removes access to about:profiles.
  64 ```
  65 {
  66   "policies": {
  67     "BlockAboutProfiles": true
  68   }
  69 }
  70 ```
  71 ### BlockAboutSupport
  72 This policy removes access to about:support.
  73 ```
  74 {
  75   "policies": {
  76     "BlockAboutSupport": true
  77 }
  78 ```
  79 ### Bookmarks
  80 This policy allows you to specify bookmarks. You can have any number of bookmarks, although only ten are specified in the ADMX file.
  81 Placement can be specified as either toolbar or menu. If a folder is specified, it is automatically created and bookmarks with the
  82 same folder name are grouped together.
  83 ```
  84 {
  85   "policies": {
  86     "Bookmarks": [
  87       {
  88         "Title": "Example",
  89         "URL": "http://example.org",
  90         "Favicon": "http://example.com/favicon.ico",
  91         "Placement": ["toolbar", "menu"],
  92         "Folder": "FolderName"
  93       }
  94     ]
  95   }
  96 }
  97 ```
  98 ### CaptivePortal
  99 This policy enables or disables captive portal support by setting and locking the preference `network.captive-portal-service.enabled`.
 100 ```
 101 {
 102   "policies": {
 103     "CaptivePortal": [true|false]
 104 }
 105 ```
 106 ### Certificates
 107 This policy can be used to install certificates or to read certificates from the system certificate store on Mac and Windows.
 108
 109 The ImportEnterpriseRoots key will cause Firefox to import 3rd party certificates that have been added by a user administrator from the system certificate store.
 110 It does not import all certificates. These certificates will not display in the Firefox certificates manager.
 111
 112 The Install Certificates key by default will search for certificates in the locations listed below.
 113 Starting in Firefox 65 you can specify a fully qualified path including UNC. (See cert3.der and cert4.pem, in example).
 114
 115 **Be advised if you wish to load a certificate from a UNC path you must use double backslashes.**
 116 Example: \\\\SERVER\\CERTS\\CERT5.PEM
 117
 118
 119 If Firefox does not find something at your fully qualified path, it will search the default directories.
 120
 121 Certificates can be located in the following locations:
 122 - Windows
 123   - %USERPROFILE%\AppData\Local\Mozilla\Certificates
 124   - %USERPROFILE%\AppData\Roaming\Mozilla\Certificates
 125 - macOS
 126   - /Library/Application Support/Mozilla/Certificates
 127   - ~/Library/Application Support/Mozilla/Certificates
 128 - Linux
 129   - /usr/lib/mozilla/certificates
 130   - /usr/lib64/mozilla/certificates
 131   - ~/.mozilla/certificates
 132
 133
 134 ```
 135 {
 136   "policies": {
 137     "Certificates": {
 138       "ImportEnterpriseRoots": true,
 139       "Install": ["cert1.der", "cert2.pem", "%SYSTEMDRIVE%\\Company\\cert3.der", "/Library/Company/cert4.pem", "\\\\server\\certs\\cert.pem"]
 140     }
 141   }
 142 }
 143 ```
 144 ### Cookies
 145 This policy controls various settings related to cookies.
 146 ```
 147 {
 148   "policies": {
 149     "Cookies": {
 150       "Allow": ["http://example.org/"], /* Domains where cookies are always allowed */
 151       "Block": ["http://example.edu/"], /* Domains where cookies are always blocked */
 152       "Default": [true|false], /* This sets the default value for "Accept cookies from websites" */
 153       "AcceptThirdParty": ["always", "never", "from-visited"], /* This sets the default value for "Accept third-party cookies" */
 154       "ExpireAtSessionEnd":  [true|false], /* This determines when cookies expire */
 155       "RejectTracker": [true|false], /* Only reject trackers */
 156       "Locked": [true|false] /* If this is true, cookies preferences can't be changed */
 157     }
 158   }
 159 }
 160 ```
 161 ### DNSOverHTTPS
 162 This policy configures DNS over HTTPS.
 163 ```
 164 {
 165   "policies": {
 166     "DNSOverHTTPS": {
 167       "Enabled": [true|false],
 168       "ProviderURL": "URL_TO_ALTERNATE_PROVIDER",
 169       "Locked": [true|false]
 170     }
 171   }
 172 }
 173 ```
 174 ### DisableSetDesktopBackground
 175 This policy removes the "Set As Desktop Background..." menuitem when right clicking on an image.
 176 ```
 177 {
 178   "policies": {
 179     "DisableSetDesktopBackground": true
 180   }
 181 }
 182 ```
 183 ### DisableMasterPasswordCreation
 184 If this policy is set to true, the master password functionality is removed.
 185 ```
 186 {
 187   "policies": {
 188     "DisableMasterPasswordCreation": [true|false]
 189   }
 190 }
 191 ```
 192 ### DisableAppUpdate
 193 This policy turns off application updates.
 194 ```
 195 {
 196   "policies": {
 197     "DisableAppUpdate": true
 198   }
 199 }
 200 ```
 201 ### DisableBuiltinPDFViewer
 202 This policy disables the built in PDF viewer. PDF files are downloaded and sent externally.
 203 ```
 204 {
 205   "policies": {
 206     "DisableBuiltinPDFViewer": true
 207   }
 208 }
 209 ```
 210 ### DisableDeveloperTools
 211 This policy removes access to all developer tools.
 212 ```
 213 {
 214   "policies": {
 215     "DisableDeveloperTools": true
 216   }
 217 }
 218 ```
 219 ### DisableFeedbackCommands
 220 This policy disables the menus for reporting sites (Submit Feedback, Report Deceptive Site).
 221 ```
 222 {
 223   "policies": {
 224     "DisableFeedbackCommands": true
 225   }
 226 }
 227 ```
 228 ### DisableFirefoxScreenshots
 229 This policy removes access to Firefox Screenshots.
 230 ```
 231 {
 232   "policies": {
 233     "DisableFirefoxScreenshots": true
 234   }
 235 }
 236 ```
 237 ### DisableFirefoxAccounts
 238 This policy disables Sync.
 239 ```
 240 {
 241   "policies": {
 242     "DisableFirefoxAccounts": true
 243   }
 244 }
 245 ```
 246 ### DisableFirefoxStudies
 247 This policy disables Firefox studies (Shield).
 248 ```
 249 {
 250   "policies": {
 251     "DisableFirefoxStudies": true
 252   }
 253 }
 254 ```
 255 ### DisableForgetButton
 256 This policy disables the "Forget" button.
 257 ```
 258 {
 259   "policies": {
 260     "DisableForgetButton": true
 261   }
 262 }
 263 ```
 264 ### DisableFormHistory
 265 This policy turns off the browser.formfill.enable preferences.
 266 ```
 267 {
 268   "policies": {
 269     "DisableFormHistory": true
 270   }
 271 }
 272 ```
 273 ### DisablePocket
 274 This policy turns off Pocket.
 275 ```
 276 {
 277   "policies": {
 278     "DisablePocket": true
 279   }
 280 }
 281 ```
 282 ### DisablePrivateBrowsing
 283 This policy removes access to private browsing.
 284 ```
 285 {
 286   "policies": {
 287     "DisablePrivateBrowsing": true
 288   }
 289 }
 290 ```
 291 ### DisableProfileImport
 292 This policy disables the "Import data from another browser" option in the bookmarks window.
 293 ```
 294 {
 295   "policies": {
 296     "DisableProfileImport": true
 297   }
 298 }
 299 ```
 300 ### DisableProfileRefresh
 301 This policy disables the Refresh Firefox button on about:support and support.mozilla.org.
 302 ```
 303 {
 304   "policies": {
 305     "DisableProfileRefresh": true
 306   }
 307 }
 308 ```
 309 ### DisableSafeMode
 310 This policy disables safe mode on Windows and macOS only.
 311 ```
 312 {
 313   "policies": {
 314     "DisableSafeMode": true
 315   }
 316 }
 317 ```
 318 ### DisableSecurityBypass
 319 This policy prevents the user from bypassing security in certain cases.
 320 ```
 321 {
 322   "policies": {
 323     "DisableSecurityBypass": {
 324       "InvalidCertificate": [true|false], /* Prevents adding an exception when an invalid certificate is shown */
 325       "SafeBrowsing": [true|false]        /* Prevents selecting "ignore the risk" and visiting a harmful site anyway */
 326     }
 327   }
 328 }
 329 ```
 330 ### DisableSystemAddonUpdate
 331 This policy prevents system add-ons from being updated or installed.
 332 ```
 333 {
 334   "policies": {
 335     "DisableSystemAddonUpdate": true
 336   }
 337 }
 338 ```
 339 ### DisableTelemetry
 340 This policy prevents the upload of telemetry data.
 341
 342 Mozilla recommends that you do not disable telemetry. Information collected through telemetry helps us build a better product for businesses like yours.
 343 ```
 344 {
 345   "policies": {
 346     "DisableTelemetry": true
 347   }
 348 }
 349 ```
 350 ### DisplayBookmarksToolbar
 351 This policy turns on the bookmarks toolbar by default. A user can still turn it off, and it will stay off.
 352 ```
 353 {
 354   "policies": {
 355     "DisplayBookmarksToolbar": true
 356   }
 357 }
 358 ```
 359 ### DisplayMenuBar
 360 This policy turns on the menubar by default. A user can still turn it off, and it will stay off.
 361 ```
 362 {
 363   "policies": {
 364     "DisplayMenuBar": true
 365   }
 366 }
 367 ```
 368 ### DontCheckDefaultBrowser
 369 This policy stops Firefox from checking if it is the default browser at startup.
 370 ```
 371 {
 372   "policies": {
 373     "DontCheckDefaultBrowser": true
 374   }
 375 }
 376 ```
 377 ### EnableTrackingProtection
 378 This policy affects tracking protection.
 379
 380 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.
 381
 382 If Value is set to false, tracking protection is disabled and locked in both the regular browser and private browsing.
 383
 384 If Value is set to true, tracking protection is enabled by default in both the regular browser and private browsing.
 385
 386 You can choose to set the Locked value if you want to prevent the user from changing it.
 387 ```
 388 {
 389   "policies": {
 390     "EnableTrackingProtection": {
 391       "Value": [true, false],
 392       "Locked": [true, false]
 393     }
 394 }
 395 ```
 396 ### Extensions
 397 This policy controls the installation, uninstallation and locking of extensions. Locked extensions cannot be disabled or uninstalled.
 398 For Install, you specify a list of URLs or paths.
 399 For Uninstall and Locked, you specify extension IDs.
 400 ```
 401 {
 402   "policies": {
 403     "Extensions": {
 404       "Install": ["https://addons.mozilla.org/firefox/downloads/somefile.xpi", "//path/to/xpi"],
 405       "Uninstall": ["addon_id@mozilla.org"],
 406       "Locked":  ["addon_id@mozilla.org"]
 407     }
 408   }
 409 }
 410 ```
 411 ### ExtensionUpdate
 412 This policy enables or disables extension updates by setting and locking the preference `extensions.update.enabled`.
 413 ```
 414 {
 415   "policies": {
 416     "ExtensionUpdate": [true|false]
 417 }
 418 ```
 419 ### HardwareAcceleration
 420 This policy disables hardware acceleration by locking the preference layers.acceleration.disabled to true.
 421 ```
 422 {
 423   "policies": {
 424     "HardwareAcceleration": false
 425   }
 426 }
 427 ```
 428 ### NoDefaultBookmarks
 429 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.
 430 ```
 431 {
 432   "policies": {
 433     "NoDefaultBookmarks": true
 434   }
 435 }
 436 ```
 437 ### OfferToSaveLogins
 438 This policy sets the signon.rememberSignons preference. It determines whether or not Firefox offers to save passwords. It can either be enabled or disabled.
 439 ```
 440 {
 441   "policies": {
 442     "OfferToSaveLogins": true
 443   }
 444 }
 445 ```
 446 ### Homepage
 447 This policy sets the default homepage value and the default start page.  It can also be used to lock the homepage or add additional homepages.
 448 ```
 449 {
 450   "policies": {
 451     "Homepage": {
 452       "URL": "http://example.com/",
 453       "Locked": true,
 454       "Additional": ["http://example.org/",
 455                      "http://example.edu/"],
 456       "StartPage": ["none", "homepage", "previous-session"]
 457     }
 458   }
 459 }
 460 ```
 461 ### PopupBlocking
 462 This policy sets domains for which pop-up windows are allowed. It also sets the default pop-up policy.
 463 ```
 464 {
 465   "policies": {
 466     "PopupBlocking": {
 467       "Allow": ["http://example.org/",
 468                 "http://example.edu/"],
 469       "Default": [true|false], /* If this is set to false, pop-up window are enabled by default. */
 470       "Locked": [true|false]
 471     }
 472   }
 473 }
 474 ```
 475 ### InstallAddonsPermission
 476 This policy sets domains that can install extensions, as well as the default behavior.
 477 ```
 478 {
 479   "policies": {
 480     "InstallAddonsPermission": {
 481       "Allow": ["http://example.org/",
 482                 "http://example.edu/"],
 483       "Default": [true|false] /* If this is set to false, add-ons cannot be installed by the user */
 484     }
 485   }
 486 }
 487 ```
 488 ### FlashPlugin
 489 This policy sets the behavior of Flash on the specified domains, as well as the default behavior.
 490 ```
 491 {
 492   "policies": {
 493     "FlashPlugin": {
 494       "Allow": ["http://example.org/"], /* Sites on the allow list do not override Flash being completely disabled */
 495       "Block": ["http://example.edu/"],
 496       "Default": [true|false], /* If this is set to true, Flash is always enabled. If it is set to false, Flash is never enabled */
 497       "Locked": [true|false]
 498     }
 499   }
 500 }
 501 ```
 502 ### NetworkPrediction
 503 This policy enables or disables network prediction (DNS prefetching) by setting and locking the preferences `network.dns.disablePrefetch` and `network.dns.disablePrefetchFromHTTPS`.
 504 ```
 505 {
 506   "policies": {
 507     "NetworkPrediction": [true|false]
 508 }
 509 ```
 510 ### OverrideFirstRunPage
 511 This policy allows you to override the first run page. If you leave the URL blank, the first run page will not be displayed.
 512 ```
 513 {
 514   "policies": {
 515     "OverrideFirstRunPage": "http://example.org"
 516   }
 517 }
 518 ```
 519 ### OverridePostUpdatePage
 520 This policy allows you to override the upgrade page. If you leave the URL blank, the upgrade page will not be displayed.
 521 ```
 522 {
 523   "policies": {
 524     "OverridePostUpdatePage": "http://example.org"
 525   }
 526 }
 527 ```
 528 ### Permissions
 529 This policy allows you to change the permissions associated with camera, microphone, location, and notifications
 530 ```
 531 {
 532   "policies": {
 533     "Permissions": {
 534       "Camera": {
 535         "Allow": ["http://example.org/"], /* Origins where camera access is allowed by default */
 536         "Block": ["http://example.org/"], /* Origins where camera access is blocked by default */
 537         "BlockNewRequests": [true|false], /* Block new requests to access the camera */
 538         "Locked": [true|false] /* Don't allow the user to change the camera preferences */
 539       },
 540       "Microphone": {
 541         "Allow": ["http://example.org/"], /* Origins where microphone access is allowed by default */
 542         "Block": ["http://example.org/"], /* Origins where microphone access  is blocked by default */
 543         "BlockNewRequests": [true|false], /* Block new requests to access the microphone */
 544         "Locked": [true|false] /* Don't allow the user to change the microphone preferences */
 545       },
 546       "Location": {
 547         "Allow": ["http://example.org/"], /* Origins where location access is allowed by default */
 548         "Block": ["http://example.org/"], /* Origins where location access is blocked by default */
 549         "BlockNewRequests": [true|false], /* Block new requests to access location */
 550         "Locked": [true|false] /* Don't allow the user to change the location preferences */
 551       },
 552       "Notifications": {
 553         "Allow": ["http://example.org/"], /* Origins where sending notifications is allowed by default */
 554         "Block": ["http://example.org/"], /* Origins where sending notifications is blocked by default */
 555         "BlockNewRequests": [true|false], /* Block new requests to send notifications */
 556         "Locked": [true|false] /* Don't allow the user to change the notification preferences */
 557       }
 558     }
 559   }
 560 }
 561 ```
 562 ### Proxy
 563 This policy allows you to specify proxy settings. These settings correspond to the connection settings in Firefox preferences.
 564 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.
 565 ```
 566 {
 567   "policies": {
 568     "Proxy": {
 569       "Mode": ["none", "system", "manual", "autoDetect", "autoConfig"],
 570       "Locked": [true, false],
 571       "HTTPProxy": "hostname",
 572       "UseHTTPProxyForAllProtocols": [true, false],
 573       "SSLProxy": "hostname",
 574       "FTPProxy": "hostname",
 575       "SOCKSProxy": "hostname",
 576       "SOCKSVersion": [4, 5],
 577       "Passthrough": "List of passthrough addresses/domains",
 578       "AutoConfigURL": "URL_TO_AUTOCONFIG",
 579       "AutoLogin":  [true, false],
 580       "UseProxyForDNS": [true, false]
 581     }
 582   }
 583 }
 584 ```
 585 ### RequestedLocales
 586 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.
 587 ```
 588 {
 589   "policies": {
 590     "RequestedLocales": ["de", "en-US"]
 591   }
 592 }
 593 ```
 594 ### SanitizeOnShutdown
 595 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.
 596 ```
 597 {
 598   "policies": {
 599     "SanitizeOnShutdown": [true|false]
 600   }
 601 }
 602 ```
 603 ### SearchBar
 604 This policy can be used to determine if the search bar is separate or combined with the URL bar.
 605 ```
 606 {
 607   "policies": {
 608     "SearchBar": ["unified", "separate"]
 609   }
 610 }
 611 ```
 612 ### WebsiteFilter
 613 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.
 614 ```
 615 {
 616   "policies": {
 617     "WebsiteFilter": {
 618       "Block": ["<all_urls>"],
 619       "Exceptions": ["http://example.org/*"]
 620     }
 621   }
 622 }
 623 ```
 624 ### Search Engines (This policy is only available on the ESR.)
 625 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.
 626 ```
 627 {
 628   "policies": {
 629     "SearchEngines": {
 630       "Add": [
 631         {
 632           "Name": "",
 633           "URLTemplate": "URL including {searchTerms} to substitute for the terms",
 634           "Method": ["GET", "POST"],
 635           "IconURL": "URL to icon",
 636           "Alias": "Alias that can be used to access the engine",
 637           "Description": "Description",
 638           "SuggestURLTemplate": "URL for suggestions using {searchTerms}"
 639         }
 640       ],
 641       "Default": "Name of engine",
 642       "PreventInstalls": [true|false],
 643       "Remove": ["Twitter", "Wikipedia (en)"]
 644     }
 645   }
 646 }
 647 ```
 648 ### SecurityDevices
 649 This policy allows you to add PKCS #11 Modules
 650 ```
 651 {
 652   "policies": {
 653     "SecurityDevices": {
 654       "NAME_OF_DEVICE": "PATH_TO_LIBRARY_FOR_DEVICE"
 655     }
 656   }
 657 }
 658 ```
 659 ### SSLVersionMin
 660 This policy allows you to set the minimum TLS version.
 661 ```
 662 {
 663   "policies": {
 664     "SSSLVersionMin": ["tls1", "tls1.1", "tls1.2",. "tls1.3"]
 665   }
 666 }
 667
 668 ```
 669 ### SSLVersionMax
 670 This policy allows you to set the maximum TLS version.
 671 ```
 672 {
 673   "policies": {
 674     "SSSLVersionMax": ["tls1", "tls1.1", "tls1.2",. "tls1.3"]
 675   }
 676 }
 677 ```