README.md

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