FAQ New Site with 2FA Support

I want to add a site using two factor authentication to the list

Great! Here's a guide on how to do that.

1. First, fork this project and clone your fork to your computer.

2. Select the category keyword(s) for the site from _data/categories.json. If nothing fits, choose other.

3. Let's assume the domain is example.com - you would then create a file entries/e/example.com.json like this:

   {
     "Example Site": {
       "domain": "example.com",
       "url": "https://subdomain.example.com",
       "img": "example.com.png",
       "tfa": [
         "sms",
         "email",
         "call",
         "custom-hardware",
         "custom-software",
         "totp",
         "u2f"
       ],
       "documentation": "https://help.example.com/faq/two-factor-setup.html",
       "recovery": "https://help.example.com/faq/two-factor-recovery.html",
       "keywords": [
         "developer",
         "education"
       ],
       "regions": [
         "us",
         "ca",
         "gb"
       ]
     }
   }
   

   • The url entry is optional if https://example.com is working correctly.

   • If you're unsure which 2FA method to use, read our FAQ on 2FA Types.

   • If the site supports HTTPS, be sure to use it in their URL, not just HTTP.

   • For sites that support 2FA, the twitter, facebook, email_address and lang entries must be removed.

   • The regions block is optional and may contain country codes according to ISO 3166-2 which specify the primary target market(s) for the website. If there is no regions tag, the website is considered to be available internationally.

4. Now choose an appropriate logo for the site. We prefer SVG files for the logo. If none is available, please use a PNG file of exactly 32x32, 64x64 or 128x128 pixels. If you can't find any with those dimensions then we recommend you downscale a larger image.

   Please run the icon through an optimizer like nano (for SVGs) or TinyPNG (for PNGs).

   File size must be smaller than 10 kB or 2.5 kB respectively. When you're done, put the image in img/e/example.com.svg or whatever different name you have given as img.

5. Use a git client to upload your changes to your fork. For Windows and Mac, we recommend GitHub for Desktop. If you're using Linux (Debian/Ubuntu) then take a look at this tutorial.

6. Everything done? Then make a Pull Request (PR)! Once everything looks nice it's time to request to add the site. Go to your fork on GitHub and click the New pull request button. It looks like this: