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 (Machine only)
  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 ### DisableSetDesktopBackground
  73 This policy removes the "Set As Desktop Background..." menuitem when right clicking on an image.
  74 ```
  75 {
  76   "policies": {
  77     "DisableSetDesktopBackground": true
  78   }
  79 }
  80 ```
  81 ### Certificates
  82 If this Windows only policy is set to true, Firefox reads certificates from the Windows certificate store.
  83 ```
  84 {
  85   "policies": {
  86     "Certificates": {
  87       "ImportEnterpriseRoots": [true|false]
  88     }
  89   }
  90 }
  91 ```
  92 ### Cookies
  93 This policy controls various settings related to cookies.
  94 ```
  95 {
  96   "policies": {
  97     "Cookies": {
  98       "Allow": ["http://example.org/"], /* Domains where cookies are always allowed */
  99       "Block": ["http://example.edu/"], /* Domains where cookies are always blocked */
 100       "Default": [true|false], /* This sets the default value for "Accept cookies from websites" */
 101       "AcceptThirdParty": ["always", "never", "from-visited"], /* This sets the default value for "Accept third-party cookies" */
 102       "ExpireAtSessionEnd":  [true|false], /* This determines when cookies expire */
 103       "Locked": [true|false] /* If this is true, cookies preferences can't be changed */
 104     }
 105   }
 106 }
 107 ```
 108 ### DisableMasterPasswordCreation
 109 If this policy is set to true, the master password functionality is removed.
 110 ```
 111 {
 112   "policies": {
 113     "DisableMasterPasswordCreation": [true|false]
 114   }
 115 }
 116 ```
 117 ### DisableAppUpdate (Machine only)
 118 This policy turns off application updates.
 119 ```
 120 {
 121   "policies": {
 122     "DisableAppUpdate": true
 123   }
 124 }
 125 ```
 126 ### DisableBuiltinPDFViewer
 127 This policy disables the built in PDF viewer. PDF files are downloaded and sent externally.
 128 ```
 129 {
 130   "policies": {
 131     "DisableBuiltinPDFViewer": true
 132   }
 133 }
 134 ```
 135 ### DisableDeveloperTools
 136 This policy removes access to all developer tools.
 137 ```
 138 {
 139   "policies": {
 140     "DisableDeveloperTools": true
 141   }
 142 }
 143 ```
 144 ### DisableFeedbackCommands
 145 This policy disables the menus for reporting sites (Submit Feedback, Report Deceptive Site).
 146 ```
 147 {
 148   "policies": {
 149     "DisableFeedbackCommands": true
 150   }
 151 }
 152 ```
 153 ### DisableFirefoxScreenshots
 154 This policy removes access to Firefox Screenshots.
 155 ```
 156 {
 157   "policies": {
 158     "DisableFirefoxScreenshots": true
 159   }
 160 }
 161 ```
 162 ### DisableFirefoxAccounts
 163 This policy disables Sync.
 164 ```
 165 {
 166   "policies": {
 167     "DisableFirefoxAccounts": true
 168   }
 169 }
 170 ```
 171 ### DisableFirefoxStudies
 172 This policy disables Firefox studies (Shield).
 173 ```
 174 {
 175   "policies": {
 176     "DisableFirefoxStudies": true
 177   }
 178 }
 179 ```
 180 ### DisableForgetButton
 181 This policy disables the "Forget" button.
 182 ```
 183 {
 184   "policies": {
 185     "DisableForgetButton": true
 186   }
 187 }
 188 ```
 189 ### DisableFormHistory
 190 This policy turns off the browser.formfill.enable preferences.
 191 ```
 192 {
 193   "policies": {
 194     "DisableFormHistory": true
 195   }
 196 }
 197 ```
 198 ### DisablePocket
 199 This policy turns off Pocket.
 200 ```
 201 {
 202   "policies": {
 203     "DisablePocket": true
 204   }
 205 }
 206 ```
 207 ### DisablePrivateBrowsing
 208 This policy removes access to private browsing.
 209 ```
 210 {
 211   "policies": {
 212     "DisablePrivateBrowsing": true
 213   }
 214 }
 215 ```
 216 ### DisableProfileImport
 217 This policy disables the "Import data from another browser" option in the bookmarks window.
 218 ```
 219 {
 220   "policies": {
 221     "DisableProfileImport": true
 222   }
 223 }
 224 ```
 225 ### DisableProfileRefresh
 226 This policy disables the Refresh Firefox button on about:support and support.mozilla.org.
 227 ```
 228 {
 229   "policies": {
 230     "DisableProfileRefresh": true
 231   }
 232 }
 233 ```
 234 ### DisableSafeMode
 235 This policy disables safe mode on Windows only.
 236 ```
 237 {
 238   "policies": {
 239     "DisableSafeMode": true
 240   }
 241 }
 242 ```
 243 ### DisableSecurityBypass
 244 This policy prevents the user from bypassing security in certain cases.
 245 ```
 246 {
 247   "policies": {
 248     "DisableSecurityBypass": {
 249       "InvalidCertificate": [true|false], /* Prevents adding an exception when an invalid certificate is shown */
 250       "SafeBrowsing": [true|false]        /* Prevents selecting "ignore the risk" and visiting a harmful site anyway */
 251     }
 252   }
 253 }
 254 ```
 255 ### DisableSystemAddonUpdate (Machine only)
 256 This policy prevents system add-ons from being updated or installed.
 257 ```
 258 {
 259   "policies": {
 260     "DisableSystemAddonUpdate": true
 261   }
 262 }
 263 ```
 264 ### DisableTelemetry (Machine only)
 265 This policy prevents the upload of telemetry data.
 266
 267 Mozilla recommends that you do not disable telemetry. Information collected through telemetry helps us build a better product for businesses like yours.
 268 ```
 269 {
 270   "policies": {
 271     "DisableTelemetry": true
 272   }
 273 }
 274 ```
 275 ### DisplayBookmarksToolbar
 276 This policy turns on the bookmarks toolbar by default. A user can still turn it off, and it will stay off.
 277 ```
 278 {
 279   "policies": {
 280     "DisplayBookmarksToolbar": true
 281   }
 282 }
 283 ```
 284 ### DisplayMenuBar
 285 This policy turns on the menubar by default. A user can still turn it off, and it will stay off.
 286 ```
 287 {
 288   "policies": {
 289     "DisplayMenuBar": true
 290   }
 291 }
 292 ```
 293 ### DontCheckDefaultBrowser
 294 This policy stops Firefox from checking if it is the default browser at startup.
 295 ```
 296 {
 297   "policies": {
 298     "DontCheckDefaultBrowser": true
 299   }
 300 }
 301 ```
 302 ### EnableTrackingProtection
 303 This policy affects tracking protection.
 304
 305 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.
 306
 307 If Value is set to false, tracking protection is disabled and locked in both the browser and private browsing.
 308
 309 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.
 310 ```
 311 {
 312   "policies": {
 313     "EnableTrackingProtection": {
 314       "Value": [true, false],
 315       "Locked": [true, false]
 316     }
 317 }
 318 ```
 319 ### Extensions (Machine only)
 320 This policy controls the installation, uninstallation and locking of extensions. Locked extensions cannot be disabled or uninstalled.
 321 For Install, you specify a list of URLs or paths.
 322 For Uninstall and Locked, you specify extension IDs.
 323 ```
 324 {
 325   "policies": {
 326     "Extensions": {
 327       "Install": ["https://addons.mozilla.org/firefox/downloads/somefile.xpi", "//path/to/xpi"]
 328       "Uninstall": ["addon_id@mozilla.org"],
 329       "Locked":  ["addon_id@mozilla.org"]
 330     }
 331 }
 332 ```
 333 ### NoDefaultBookmarks
 334 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.
 335 ```
 336 {
 337   "policies": {
 338     "NoDefaultBookmarks": true
 339   }
 340 }
 341 ```
 342 ### OfferToSaveLogins
 343 This policy sets the signon.rememberSignons preference. It determines whether or not Firefox offers to save passwords. It can either be enabled or disabled.
 344 ```
 345 {
 346   "policies": {
 347     "OfferToSaveLogins": true
 348   }
 349 }
 350 ```
 351 ### Homepage (Machine only)
 352 This policy sets the default homepage value. It can also be used to lock the homepage and add additional homepages.
 353 ```
 354 {
 355   "policies": {
 356     "Homepage": {
 357       "URL": "http://example.com/",
 358       "Locked": true,
 359       "Additional": ["http://example.org/",
 360                      "http://example.edu/"]
 361     }
 362   }
 363 }
 364 ```
 365 ### PopupBlocking
 366 This policy sets domains for which pop-up windows are allowed. It also sets the default pop-up policy.
 367 ```
 368 {
 369   "policies": {
 370     "PopupBlocking": {
 371       "Allow": ["http://example.org/",
 372                 "http://example.edu/"],
 373       "Default": [true|false], /* If this is set to false, pop-up window are enabled by default. */
 374       "Locked": [true|false]
 375     }
 376   }
 377 }
 378 ```
 379 ### InstallAddonsPermission
 380 This policy sets domains that can install extensions, as well as the default behavior.
 381 ```
 382 {
 383   "policies": {
 384     "InstallAddonsPermission": {
 385       "Allow": ["http://example.org/",
 386                 "http://example.edu/"],
 387       "Default": [true|false] /* If this is set to false, add-ons cannot be installed by the user */
 388     }
 389   }
 390 }
 391 ```
 392 ### FlashPlugin
 393 This policy sets the behavior of Flash on the specified domains, as well as the default behavior.
 394 ```
 395 {
 396   "policies": {
 397     "FlashPlugin": {
 398       "Allow": ["http://example.org/"], /* Sites on the allow list do not override Flash being completely disabled */
 399       "Block": ["http://example.edu/"],
 400       "Default": [true|false], /* If this is set to true, Flash is always enabled. If it is set to false, Flash is never enabled */
 401       "Locked": [true|false]
 402     }
 403   }
 404 }
 405 ```
 406 ### OverrideFirstRunPage (Machine only)
 407 This policy allows you to override the first run page. If you leave the URL blank, the first run page will not be displayed.
 408 ```
 409 {
 410   "policies": {
 411     "OverrideFirstRunPage": "http://example.org"
 412   }
 413 }
 414 ```
 415 ### OverridePostUpdatePage (Machine only)
 416 This policy allows you to override the upgrade page. If you leave the URL blank, the upgrade page will not be displayed.
 417 ```
 418 {
 419   "policies": {
 420     "OverridePostUpdatePage": "http://example.org"
 421   }
 422 }
 423 ```
 424 ### Bookmarks
 425 This policy allows you to specify bookmarks. You can have any number of bookmarks, although only ten are specified in the ADMX file.
 426 Placement can be specified as either toolbar or menu. If a folder is specified, it is automatically created and bookmarks with the
 427 same folder name are grouped together.
 428
 429 ```
 430 {
 431   "policies": {
 432     "Bookmarks": [
 433       {
 434         "Title": "Example",
 435         "URL": "http://example.org",
 436         "Favicon": "http://example.com/favicon.ico",
 437         "Placement": ["toolbar", "menu"],
 438         "Folder": "FolderName"
 439       }
 440     ]
 441   }
 442 }
 443 ```
 444 ### Proxy
 445 This policy allows you to specify proxy settings. These settings correspond to the connection settings in Firefox preferences.
 446 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.
 447 ```
 448 {
 449   "policies": {
 450     "Proxy": {
 451       "Mode": ["none", "system", "manual", "autoDetect", "autoConfig"],
 452       "Locked": [true, false],
 453       "HTTPProxy": "hostname",
 454       "UseHTTPProxyForAllProtocols": [true, false],
 455       "SSLProxy": "hostname",
 456       "FTPProxy": "hostname",
 457       "SOCKSProxy": "hostname",
 458       "SOCKSVersion": [4, 5],
 459       "Passthrough": "List of passthrough addresses/domains",
 460       "AutoConfigURL": "URL_TO_AUTOCONFIG",
 461       "AutoLogin":  [true, false],
 462       "UseProxyForDNS": [true, false]
 463     }
 464   }
 465 }
 466 ```
 467 ### SanitizeOnShutdown
 468 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.
 469 ```
 470 {
 471   "policies": {
 472     "SanitizeOnShutdown": [true|false]
 473   }
 474 }
 475 ```
 476 ### SearchBar (Machine only)
 477 This policy can be used to determine if the search bar is separate or combined with the URL bar.
 478 ```
 479 {
 480   "policies": {
 481     "SearchBar": ["unified", "separate"]
 482   }
 483 }
 484 ```
 485 ### WebsiteFilter (Machine only)
 486 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.
 487 ```
 488 {
 489   "policies": {
 490     "WebsiteFilter": {
 491       "Block": ["<all_urls>"],
 492       "Exceptions": ["http://example.org/*"]
 493     }
 494   }
 495 }
 496 ```
 497 ### Search Engines (Machine only)
 498 This policy allows you to add new search engines, as well as set the default and prevent the install of search engines from web pages. Only Name and URLTemplate is required.
 499 ```
 500 {
 501   "policies": {
 502     "SearchEngines": {
 503       "Add": [
 504         {
 505           "Name": "",
 506           "URLTemplate": "URL including {searchTerms} to substitute for the terms",
 507           "Method": ["GET", "POST"],
 508           "IconURL": "URL to icon",
 509           "Alias": "Alias that can be used to access the engine",
 510           "Description": "Description",
 511           "SuggestURLTemplate": "URL for suggestions using {searchTerms}"
 512         }
 513       ],
 514       "Default": "Name of engine",
 515       "PreventInstalls": [true|false]
 516     }
 517   }
 518 }
 519 ```