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