README.md

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