diff --git a/Browser-support.md b/Browser-support.md new file mode 100644 index 0000000..295ee27 --- /dev/null +++ b/Browser-support.md @@ -0,0 +1,3 @@ +nightTab as an extension officially 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. diff --git a/Cookies-and-cache.md b/Cookies-and-cache.md new file mode 100644 index 0000000..3fed2af --- /dev/null +++ b/Cookies-and-cache.md @@ -0,0 +1,5 @@ +nightTab does not collect, store or send your data anywhere. All your data is saved locally 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. diff --git a/Data-backup-and-restore.md b/Data-backup-and-restore.md new file mode 100644 index 0000000..bb8d2a3 --- /dev/null +++ b/Data-backup-and-restore.md @@ -0,0 +1,32 @@ +nightTab is privacy first extension and does not save any user data on a remote database. All data is saved locally in the browser. + +Data controls can be found in ![Settings](image/settings.svg) `Menu` > `Data`. + +# Restore data + +Use ![Settings](image/settings.svg) `Menu` > `Data` > `Restore` > `Import data` to restore a nightTab backup JSON file. + +`Bookmarks`, `Theme` or `Settings` of a nightTab setup can be restored from a 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 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 selecting which parts of the backup JSON file to restore click `Import` to complete the process. + +![nightTab Demo](image/import-data.gif) + +# Backup data + +Backup your nightTab setup frequently. This can easily be done from the ![Settings](image/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 device. 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. + + +# Clear data + +Use ![Settings](image/settings.svg) `Menu` > `Data` > `Clear` > `Clear all data` to reset nightTab to the default state. + +Alternatively, reset nightTab to the default state while keeping all bookmarks and groups. This can be done from ![Settings](image/settings.svg) `Menu` > `Data` > `Clear` > `Clear all except bookmarks`. diff --git a/Local-background-image.md b/Local-background-image.md new file mode 100644 index 0000000..bca9f31 --- /dev/null +++ b/Local-background-image.md @@ -0,0 +1,15 @@ +**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](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage) (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. diff --git a/Recovering-settings-and-bookmarks.md b/Recovering-settings-and-bookmarks.md new file mode 100644 index 0000000..67b601e --- /dev/null +++ b/Recovering-settings-and-bookmarks.md @@ -0,0 +1,7 @@ +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](https://developer.mozilla.org/en-US/docs/Learn/JavaScript/Objects/JSON#no_really_what_is_json) file, e.g. `my-nightTab-settings.json`. diff --git a/Setting-nightTab-as-your-Firefox-homepage.md b/Setting-nightTab-as-your-Firefox-homepage.md new file mode 100644 index 0000000..75ab151 --- /dev/null +++ b/Setting-nightTab-as-your-Firefox-homepage.md @@ -0,0 +1,8 @@ +Firefox does not allow addons to replace the "homepage". However there is a workaround: + +- Open a new Firefox window +- Open Firefox `Preferences` and open a new tab (nightTab) +- 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. diff --git a/image/import-data.gif b/image/import-data.gif new file mode 100644 index 0000000..3280387 Binary files /dev/null and b/image/import-data.gif differ diff --git a/image/settings.svg b/image/settings.svg new file mode 100644 index 0000000..9c1b2c3 --- /dev/null +++ b/image/settings.svg @@ -0,0 +1 @@ + diff --git a/nightTab-respects-your-privacy.md b/nightTab-respects-your-privacy.md new file mode 100644 index 0000000..77bb6ff --- /dev/null +++ b/nightTab-respects-your-privacy.md @@ -0,0 +1 @@ +This project runs completely on the client side, in the browser. No user data is sent anywhere, no remote database or central user management.