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.
  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 ### CreateMasterPassword
  70 This policy removes the master password functionality.
  71 ```
  72 {
  73   "policies": {
  74     "CreateMasterPassword": false
  75   }
  76 }
  77 ```
  78 ### DisableAppUpdate
  79 This policy turns off application updates.
  80 ```
  81 {
  82   "policies": {
  83     "DisableAppUpdate": true
  84   }
  85 }
  86 ```
  87 ### DisableBuiltinPDFViewer
  88 This policy disables the built in PDF viewer. PDF files are downloaded and sent externally.
  89 ```
  90 {
  91   "policies": {
  92     "DisableBuiltinPDFViewer": true
  93   }
  94 }
  95 ```
  96 ### DisableDeveloperTools
  97 This policy removes access to all developer tools.
  98 ```
  99 {
 100   "policies": {
 101     "DisableDeveloperTools": true
 102   }
 103 }
 104 ```
 105 ### DisableFeedbackCommands
 106 This policy disables the menus for reporting sites (Submit Feedback, Report Deceptive Site)
 107 ```
 108 {
 109   "policies": {
 110     "DisableFeedbackCommands": true
 111   }
 112 }
 113 ```
 114 ### DisableFirefoxScreenshots
 115 This policy removes access to Firefox Screenshots
 116 ```
 117 {
 118   "policies": {
 119     "DisableFirefoxScreenshots": true
 120   }
 121 }
 122 ```
 123 ### DisableFirefoxAccounts
 124 This policy disables Sync
 125 ```
 126 {
 127   "policies": {
 128     "DisableFirefoxAccounts": true
 129   }
 130 }
 131 ```
 132 ### DisableFirefoxStudies
 133 This policy disables Firefox studies (Shield)
 134 ```
 135 {
 136   "policies": {
 137     "DisableFirefoxAccounts": true
 138   }
 139 }
 140 ```
 141 ### DisableFormHistory
 142 This policy turns off the browser.formfill.enable preferences
 143 ```
 144 {
 145   "policies": {
 146     "DisableFormHistory": true
 147   }
 148 }
 149 ```
 150 ### DisablePocket
 151 This policy turns off Pocket
 152 ```
 153 {
 154   "policies": {
 155     "DisablePocket": true
 156   }
 157 }
 158 ```
 159 ### DisablePrivateBrowsing
 160 This policy removes access to private browsing
 161 ```
 162 {
 163   "policies": {
 164     "DisablePrivateBrowsing": true
 165   }
 166 }
 167 ```
 168 ### DisableSafeMode
 169 This policy disables safe mode on Windows only
 170 ```
 171 {
 172   "policies": {
 173     "DisableSafeMode": true
 174   }
 175 }
 176 ```
 177 ### DisableSysAddonUpdate
 178 This policy prevents system add-ons from being updated or installed.
 179 ```
 180 {
 181   "policies": {
 182     "DisableSysAddonUpdate": true
 183   }
 184 }
 185 ```
 186 ### DisplayBookmarksToolbar
 187 This policy turns on the bookmarks toolbar by default. A user can still turn it off and it will stay off.
 188 ```
 189 {
 190   "policies": {
 191     "DisplayBookmarksToolbar": true
 192   }
 193 }
 194 ```
 195 ### DisplayMenuBar
 196 This policy turns on the menubar by default. A user can still turn it off and it will stay off.
 197 ```
 198 {
 199   "policies": {
 200     "DisplayMenuBar": true
 201   }
 202 }
 203 ```
 204 ### DontCheckDefaultBrowser
 205 This policy stops Firefox from checking if it is the default browser at startup.
 206 ```
 207 {
 208   "policies": {
 209     "DontCheckDefaultBrowser": true
 210   }
 211 }
 212 ```
 213 ### EnableTrackingProtection
 214 This policy affects tracking protection.
 215
 216 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.
 217
 218 If Value is set to false, tracking protection is disabled and locked in both the browser and private browsing.
 219
 220 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.
 221 ```
 222 {
 223   "policies": {
 224     "EnableTrackingProtection": {
 225       "Value": [true, false],
 226       "Locked": [true, false]
 227     }
 228 ```
 229 ### NoDefaultBookmarks
 230 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.
 231 ```
 232 {
 233   "policies": {
 234     "NoDefaultBookmarks": true
 235   }
 236 }
 237 ```
 238 ### RememberPasswords
 239 This policy sets the signon.rememberSignons preference. It can either be enabled or disabled.
 240 ```
 241 {
 242   "policies": {
 243     "RememberPasswords": true
 244   }
 245 }
 246 ```
 247 ### Homepage
 248 This policy sets the default homepage value. It can also be used to lock the homepage and add additional homepages.
 249 ```
 250 {
 251   "policies": {
 252     "Homepage": {
 253       "URL": "http://example.com/",
 254       "Locked": true,
 255       "Additional": ["http://example.org/",
 256                      "http://example.edu/"]
 257     }
 258   }
 259 }
 260 ```
 261 ### Popups
 262 This policy sets domains for which popups are allowed
 263 ```
 264 {
 265   "policies": {
 266     "Popups": {
 267       "Allow": ["http://example.org/",
 268                 "http://example.edu/"]
 269     }
 270   }
 271 }
 272 ```
 273 ### InstallAddons
 274 This policy sets domains that can install extensions
 275 ```
 276 {
 277   "policies": {
 278     "InstallAddons": {
 279       "Allow": ["http://example.org/",
 280                 "http://example.edu/"]
 281     }
 282   }
 283 }
 284 ```
 285 ### Cookies
 286 This policy sets domains that can set or not set cookies.
 287 ```
 288 {
 289   "policies": {
 290     "Cookies": {
 291       "Allow": ["http://example.org/"],
 292       "Block": ["http://example.edu/"]
 293     }
 294   }
 295 }
 296 ```
 297 ### FlashPlugin
 298 This policy sets domains that can use or not use Flash
 299 ```
 300 {
 301   "policies": {
 302     "FlashPlugin": {
 303       "Allow": ["http://example.org/"],
 304       "Block": ["http://example.edu/"]
 305     }
 306   }
 307 }
 308 ```
 309 ### Bookmarks
 310 This policy allows you to specify bookmarks. You can have any number of bookmarks although only ten are specified in the ADMX file.
 311 Placement can be specified as either toolbar or menu. If a folder is specified, it is automatically created and bookmarks with the
 312 same folder name are grouped together.
 313
 314 ```
 315 {
 316   "policies": {
 317     "Bookmarks": [
 318     {"Title": "Example",
 319      "URL": "http://example.org",
 320      "Favicon": "http://example.com/favicon.ico",
 321      "Placement": ["toolbar", "menu"],
 322      "Folder": "FolderName"
 323      }
 324     ]
 325   }
 326 }
 327 ```
 328 ### Proxy
 329 This policy allows you to specify proxy settings. These settings correspond to the connection settings in Firefox preferences.
 330 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.
 331 ```
 332 {
 333   "Proxy": {
 334     "Mode": ["none", "system", "manual", "autoDetect", "autoConfig"]
 335     "Locked": [true, false]
 336     "HTTPProxy": "hostname",
 337     "UseHTTPProxyForAllProtocols": [true, false]
 338     "SSLProxy": "hostname",
 339     "FTPProxy": "hostname",
 340     "SOCKSProxy": "hostname",
 341     "SOCKSVersion": [4, 5],
 342     "Passthrough": "List of passthrough addresses/domains",
 343     "AutoConfigURL": "URL_TO_AUTOCONFIG",
 344     "AutoLogin":  [true, false],
 345     "UseProxyForDNS": [true, false]
 346   }
 347 }
 348 ```