Update FAQ and Installation Instructions for Git Sync

[balthanon]

The current instructions for setting up Git are:

1. Create a new profile in the Floccus panel
   

2. Select Git over HTTP as your sync method
   

3. The following screens show the profile settings.
   

4. First you will need to enter your Git repository URL and a branch to sync to. Make sure to use the HTTPS URL instead of the SSH URL if you have the choice. Also, make sure that the branch already exists and there are no branch rules that prevent direct commits to the branch.
   

5. Then enter your username and password for your Git hosting provider. Note, that if you have 2-factor authentication enabled for your account, you will need to use some sort of device token here instead of your actual password.
   

6. You can then enter a path and filename for the bookmarks file inside your Git repository. The easiest is to just store it in the root.
   

7. Finally, you can choose which bookmarks folder to sync to that file. By default floccus will create a new folder for you, to avoid syncing something that you don’t want synced. However, with a click on the folder icon you can select any other folder in your bookmarks. It is not advised anymore to select the topmost folder, because the built-in bookmarks folders are named differently depending on browser vendor and language, and the original attempt to bridge this gap is no longer possible.
   

8. Make sure to disable your native browser bookmark sync service, because it is likely incompatible with floccus
   

I would suggest updating them to include the following:

1. Create a new profile in the Floccus panel
   

2. Select Git over HTTP as your sync method
   

3. The following screens show the profile settings.
   

4. First you will need to enter your Git repository URL and a branch to sync to. Make sure to use the HTTPS URL instead of the SSH URL if you have the choice. Also, make sure that the branch already exists and there are no branch rules that prevent direct commits to the branch.
   

5. **If you do not have Git installed on your computer, install it and ensure that the path to the installation is included in your Path variables.**
   

6. Then enter your username and password for your Git hosting provider. **Note, that is recommended that you use a device token with read/write access to Content here instead of your actual password and may be a requirement, particularly if you have 2-factor authentication enabled for your account.**
   

7. You can then enter a path and filename for the bookmarks file inside your Git repository. The easiest is to just store it in the root.
   

8.  Finally, you can choose which bookmarks folder to sync to that file. By default floccus will create a new folder for you, to avoid syncing something that you don’t want synced. However, with a click on the folder icon you can select any other folder in your bookmarks. It is not advised anymore to select the topmost folder, because the built-in bookmarks folders are named differently depending on browser vendor and language, and the original attempt to bridge this gap is no longer possible.
   

9. Make sure to disable your native browser bookmark sync service, because it is likely incompatible with floccus
   

For the FAQ, I would also suggest having an FAQ for the 401 error, since it has popped up a couple of times on Git that I see. The ENOENT issue is probably rare enough that it doesn't merit it yet.

I am receiving a 401 HTTP error when trying to set up Floccus with Git
Try setting up a device token and using that instead of your personal password. You can find more information on the process here: floccusaddon/floccus#1655

[balthanon]

If you're good with these changes @marcelklehr, I can create a pull request for them if you don't want to make them yourself.

[marcelklehr]

Hey 💙

Awesome, sounds great! Looking forward to the PR :)

[marcelklehr]

Did you find that you needed git installed to use git with floccus? 🤔

[balthanon]

As noted in the other issue, I just ran into that ENOENT issue that made me think it was using my install. I'll leave that out of the PR when I make the updates and just focus on the 401 changes.