mirror of
https://github.com/zombieFox/nightTab.git
synced 2024-11-30 20:14:19 +01:00
update wiki
parent
1910cd1c83
commit
43ef1a3d9d
3
Browser-support.md
Normal file
3
Browser-support.md
Normal file
@ -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.
|
5
Cookies-and-cache.md
Normal file
5
Cookies-and-cache.md
Normal file
@ -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.
|
32
Data-backup-and-restore.md
Normal file
32
Data-backup-and-restore.md
Normal file
@ -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`.
|
15
Local-background-image.md
Normal file
15
Local-background-image.md
Normal file
@ -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.
|
7
Recovering-settings-and-bookmarks.md
Normal file
7
Recovering-settings-and-bookmarks.md
Normal file
@ -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`.
|
8
Setting-nightTab-as-your-Firefox-homepage.md
Normal file
8
Setting-nightTab-as-your-Firefox-homepage.md
Normal file
@ -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.
|
BIN
image/import-data.gif
Normal file
BIN
image/import-data.gif
Normal file
Binary file not shown.
After Width: | Height: | Size: 1.8 MiB |
1
image/settings.svg
Normal file
1
image/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>
|
After Width: | Height: | Size: 1.1 KiB |
1
nightTab-respects-your-privacy.md
Normal file
1
nightTab-respects-your-privacy.md
Normal file
@ -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.
|
Loading…
Reference in New Issue
Block a user