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 ### BlockSetDesktopBackground
  61 This policy removes the "Set As Desktop Background..." menuitem when right clicking on an image.
  62 ```
  63 {
  64   "policies": {
  65     "BlockAboutSupport": 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": ["all", "none", "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 ### CreateMasterPassword
  97 This policy removes the master password functionality.
  98 ```
  99 {
 100   "policies": {
 101     "CreateMasterPassword": 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 ### DisableSafeMode
 205 This policy disables safe mode on Windows only
 206 ```
 207 {
 208   "policies": {
 209     "DisableSafeMode": true
 210   }
 211 }
 212 ```
 213 ### DisableSysAddonUpdate
 214 This policy prevents system add-ons from being updated or installed.
 215 ```
 216 {
 217   "policies": {
 218     "DisableSysAddonUpdate": true
 219   }
 220 }
 221 ```
 222 ### DisplayBookmarksToolbar
 223 This policy turns on the bookmarks toolbar by default. A user can still turn it off and it will stay off.
 224 ```
 225 {
 226   "policies": {
 227     "DisplayBookmarksToolbar": true
 228   }
 229 }
 230 ```
 231 ### DisplayMenuBar
 232 This policy turns on the menubar by default. A user can still turn it off and it will stay off.
 233 ```
 234 {
 235   "policies": {
 236     "DisplayMenuBar": true
 237   }
 238 }
 239 ```
 240 ### DontCheckDefaultBrowser
 241 This policy stops Firefox from checking if it is the default browser at startup.
 242 ```
 243 {
 244   "policies": {
 245     "DontCheckDefaultBrowser": true
 246   }
 247 }
 248 ```
 249 ### EnableTrackingProtection
 250 This policy affects tracking protection.
 251
 252 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.
 253
 254 If Value is set to false, tracking protection is disabled and locked in both the browser and private browsing.
 255
 256 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.
 257 ```
 258 {
 259   "policies": {
 260     "EnableTrackingProtection": {
 261       "Value": [true, false],
 262       "Locked": [true, false]
 263     }
 264 ```
 265 ### NoDefaultBookmarks
 266 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.
 267 ```
 268 {
 269   "policies": {
 270     "NoDefaultBookmarks": true
 271   }
 272 }
 273 ```
 274 ### RememberPasswords
 275 This policy sets the signon.rememberSignons preference. It can either be enabled or disabled.
 276 ```
 277 {
 278   "policies": {
 279     "RememberPasswords": true
 280   }
 281 }
 282 ```
 283 ### Homepage
 284 This policy sets the default homepage value. It can also be used to lock the homepage and add additional homepages.
 285 ```
 286 {
 287   "policies": {
 288     "Homepage": {
 289       "URL": "http://example.com/",
 290       "Locked": true,
 291       "Additional": ["http://example.org/",
 292                      "http://example.edu/"]
 293     }
 294   }
 295 }
 296 ```
 297 ### Popups
 298 This policy sets domains for which popups are allowed
 299 ```
 300 {
 301   "policies": {
 302     "Popups": {
 303       "Allow": ["http://example.org/",
 304                 "http://example.edu/"]
 305     }
 306   }
 307 }
 308 ```
 309 ### InstallAddons
 310 This policy sets domains that can install extensions
 311 ```
 312 {
 313   "policies": {
 314     "InstallAddons": {
 315       "Allow": ["http://example.org/",
 316                 "http://example.edu/"]
 317     }
 318   }
 319 }
 320 ```
 321 ### FlashPlugin
 322 This policy sets domains that can use or not use Flash
 323 ```
 324 {
 325   "policies": {
 326     "FlashPlugin": {
 327       "Allow": ["http://example.org/"],
 328       "Block": ["http://example.edu/"]
 329     }
 330   }
 331 }
 332 ```
 333 ### Bookmarks
 334 This policy allows you to specify bookmarks. You can have any number of bookmarks although only ten are specified in the ADMX file.
 335 Placement can be specified as either toolbar or menu. If a folder is specified, it is automatically created and bookmarks with the
 336 same folder name are grouped together.
 337
 338 ```
 339 {
 340   "policies": {
 341     "Bookmarks": [
 342     {"Title": "Example",
 343      "URL": "http://example.org",
 344      "Favicon": "http://example.com/favicon.ico",
 345      "Placement": ["toolbar", "menu"],
 346      "Folder": "FolderName"
 347      }
 348     ]
 349   }
 350 }
 351 ```
 352 ### Proxy
 353 This policy allows you to specify proxy settings. These settings correspond to the connection settings in Firefox preferences.
 354 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.
 355 ```
 356 {
 357   "Proxy": {
 358     "Mode": ["none", "system", "manual", "autoDetect", "autoConfig"]
 359     "Locked": [true, false]
 360     "HTTPProxy": "hostname",
 361     "UseHTTPProxyForAllProtocols": [true, false]
 362     "SSLProxy": "hostname",
 363     "FTPProxy": "hostname",
 364     "SOCKSProxy": "hostname",
 365     "SOCKSVersion": [4, 5],
 366     "Passthrough": "List of passthrough addresses/domains",
 367     "AutoConfigURL": "URL_TO_AUTOCONFIG",
 368     "AutoLogin":  [true, false],
 369     "UseProxyForDNS": [true, false]
 370   }
 371 }
 372 ```