Rooba
/
nightTab
mirror of https://github.com/zombieFox/nightTab.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity

add support pages

zombieFox 2021-08-20 19:00:28 +01:00
parent 77cf81c876
commit fc60c8a6d2
10 changed files with 66 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored Normal file

@ -0,0 +1 @@
.DS_Store

6
Recovering-user-settings-and-bookmarks.md

@ -1,7 +1,9 @@
In the event of a bug or loading issue, user settings and bookmarks saved when using nightTab can be recovered from the browser [local storage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage).
# Recovering user settings and bookmarks
In the event of a bug or loading issue, user settings and bookmarks saved when using nightTab can be recovered from the browser [local storage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage).
1. Open nightTab
2. Open the developer tools
3. Go to the console ([Finding your browser's developer console](https://balsamiq.com/support/faqs/browserconsole/))
4. Use the command `copy(localStorage.getItem("nightTab-backup"))` or `copy(localStorage.getItem("nightTab"))` to copy your data to the clipboard
5. Paste this data into an empty text file and save as a JSON file, eg: my-nightTab-settings.json
5. Paste this data into an empty text file and save as a [JSON](https://developer.mozilla.org/en-US/docs/Learn/JavaScript/Objects/JSON#no_really_what_is_json) file, e.g. `my-nightTab-settings.json`.

4
Setting-nightTab-as-your-Firefox-homepage.md

@ -1,3 +1,5 @@
# Setting nightTab as your Firefox homepage
Firefox does not allow addons to replace the "homepage". However there is a workaround:
- Open a new Firefox window
@ -5,4 +7,4 @@ Firefox does not allow addons to replace the "homepage". However there is a work
- In Firefox preferences under `Home`, change `Homepage and new windows` to `Custom URLs...`
- Then click `Use Current Page`.
nightTab will now appear as the homepage.
nightTab will now appear as the homepage.

12
backup-nighttab-setup.md Normal file

@ -0,0 +1,12 @@
# Backup nightTab setup
nightTab is privacy first extension and does not save any user data on a remote database. For this reason if nightTab is uninstalled your start page bookmarks, settings and theme will also be removed.
For this reason you should frequently backup your settings. This can easily be done from the ![Settings](image/icon/settings.svg) `Menu` > `Data` > `Backup` > `Export Data`.
A backup [JSON](https://developer.mozilla.org/en-US/docs/Learn/JavaScript/Objects/JSON#no_really_what_is_json) file will be saved to your computer. This backup file will be named with a data and timestamp for easy reference, e.g. `nightTab backup - 2021.08.16 - 09 10 29.json`.
You can use this backup file to restore your settings on any device with nightTab installed.
To restore your setup go to ![Settings](image/icon/settings.svg) `Menu` > `Data` > `Restore` > `Import Data`. Then select the previously exported backup JSON file.

5
browser-support.md Normal file

@ -0,0 +1,5 @@
# Browser support
nightTab as an extension supports Chrome and Firefox. Testing and development is only conducted on these browsers.
Opera [does not support extensions](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/chrome_url_overrides) to change the new tab page so can not be supported in this project.

7
clearing-cookies-and-cache.md Normal file

@ -0,0 +1,7 @@
# Clearing cookies and cache
No user data is sent anywhere, no remote database or central user management. All your data is saved to your browser.
This means if you clear your browser cache or cookies nightTab will reset to its default state.
[Extensions or apps which clear your cache or cookies](https://github.com/zombieFox/nightTab/issues/209#issue-669174744) when closing the browsers will also force nightTab to reset to its default state.

1
image/icon/settings.svg Normal file

@ -0,0 +1 @@
<svg xmlns="http://www.w3.org/2000/svg" version="1.1" viewBox="0 0 24 24" width="24" height="24" fill="currentColor"><path d="M12 15.516c1.922 0 3.516-1.594 3.516-3.516s-1.594-3.516-3.516-3.516-3.516 1.594-3.516 3.516 1.594 3.516 3.516 3.516zM19.453 12.984l2.109 1.641c0.188 0.141 0.234 0.422 0.094 0.656l-2.016 3.469c-0.141 0.234-0.375 0.281-0.609 0.188l-2.484-0.984c-0.516 0.375-1.078 0.75-1.688 0.984l-0.375 2.625c-0.047 0.234-0.234 0.422-0.469 0.422h-4.031c-0.234 0-0.422-0.188-0.469-0.422l-0.375-2.625c-0.609-0.234-1.172-0.563-1.688-0.984l-2.484 0.984c-0.234 0.094-0.469 0.047-0.609-0.188l-2.016-3.469c-0.141-0.234-0.094-0.516 0.094-0.656l2.109-1.641c-0.047-0.328-0.047-0.656-0.047-0.984s0-0.656 0.047-0.984l-2.109-1.641c-0.188-0.141-0.234-0.422-0.094-0.656l2.016-3.469c0.141-0.234 0.375-0.281 0.609-0.188l2.484 0.984c0.516-0.375 1.078-0.75 1.688-0.984l0.375-2.625c0.047-0.234 0.234-0.422 0.469-0.422h4.031c0.234 0 0.422 0.188 0.469 0.422l0.375 2.625c0.609 0.234 1.172 0.563 1.688 0.984l2.484-0.984c0.234-0.094 0.469-0.047 0.609 0.188l2.016 3.469c0.141 0.234 0.094 0.516-0.094 0.656l-2.109 1.641c0.047 0.328 0.047 0.656 0.047 0.984s0 0.656-0.047 0.984z"></path></svg>
Side by Side

After

Width:  |  Height:  |  Size: 1.1 KiB

15
local-background-image-upload-is-no-longer-supported.md Normal file

@ -0,0 +1,15 @@
# Local background image upload is no longer supported
_This change was made in nightTab 7.0.0_
Allowing a user to upload local images has its benefits but also many drawbacks and issues.
As a rule, nightTab does not store any user data on a remote database. As such any image file uploaded to use as background has to be stored on the client side in local storage (in the browser cache). This [storage has a limit](https://github.com/zombieFox/nightTab/issues/93#issuecomment-679922767) (which varies between browsers) of about 5MB.
Images can very easily exceed 5MB in size. Which is a problem when the same storage is used to save user settings: the layout, bookmarks and theme settings. When this happens the browser throws an error and nightTab can’t function as expected.
[Other issues with image file support](https://github.com/zombieFox/nightTab/issues/69#issuecomment-522295606) continue to appear. Some images just fail to load.
For the reasons above the local image background controls have been dropped from the feature set.
nightTab still supports linking to image files via a URL. Just paste one or more URLs into the Theme Background input to change the background image. This method is the most reliable and uses the least amount of storage space.

3
nighttab-respects-your-privacy.md Normal file

@ -0,0 +1,3 @@
# nightTab respects your privacy
This project runs completely on the client side, in the browser. No user data is sent anywhere, no remote database or central user management.

15
restore-nighttab-setup.md Normal file

@ -0,0 +1,15 @@
# Restore nightTab setup
You can restore a nightTab backup [JSON](https://developer.mozilla.org/en-US/docs/Learn/JavaScript/Objects/JSON#no_really_what_is_json) file by going to ![Settings](image/icon/settings.svg) `Menu` > `Data` > `Restore` > `Import Data`.
From her find and select a previously exported backup JSON file on your device.
Next you will have the option to restore the `Bookmarks`, `Theme` or `Settings` from the backup JSON file.
Selecting `Bookmarks` will import the user added bookmarks which will keep any custom Colours, Accents and Borders each may have.
Selecting `Theme` will import the user added Colour, Accent, Fonts, Background and any saved Custom Themes.
Selecting `Settings` will import the Layout size and position, Header area size, Bookmark area size and other user settings.
After select which parts of the backup JSON file to restore click, `Import` to complete process.