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