Skip to content

Commit

Permalink
docs: update
Browse files Browse the repository at this point in the history
  • Loading branch information
stoically committed Jun 29, 2019
1 parent 0de245b commit 74dd010
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 29 deletions.
10 changes: 0 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,16 +60,6 @@ Check `about:debugging` and click `Debug` under Temporary Container to see the c
[Vue.js](https://vuejs.org) and [SemanticUI](https://semantic-ui.com/) are used for the preferences & popup UI.


## Limitations
* Disabled in "Private Windows" since Firefox doesn't support it
* Android Support is not possible since [Firefox doesn't support it](https://bugzilla.mozilla.org/show_bug.cgi?id=1398097)
* Mouse Clicks:
* In combination with [Multi-Account Containers](https://github.com/mozilla/multi-account-containers): Opening the same link multiple times in quick succession will probably not work as expected when the site is set to "Always open in $Container".
* Doesn't work on addons.mozilla.org (Firefox prevents content scripts there). If you assign addons.mozilla.org to "Always open in" with Multi-Account Containers you will see unexpected behavior since Add-ons, including Multi-Account Containers, are not allowed to block requests to addons.mozilla.org.
* In Automatic Mode:
* "No Container" Tab (Alt+N) and Window (Shift+Alt+C) must open about:blank due to Firefox API limitations and thus the address bar can't get focus when opening a new "No Container" tab.


## License

MIT
18 changes: 3 additions & 15 deletions docs/.vuepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,26 +3,13 @@ module.exports = {
description: 'Open tabs, websites, and links in automatically managed disposable containers',
base: '/temporary-containers/',
themeConfig: {
// Assumes GitHub. Can also be a full GitLab url.
repo: 'stoically/temporary-containers',
// Customising the header label
// Defaults to "GitHub"/"GitLab"/"Bitbucket" depending on `themeConfig.repo`
// repoLabel: 'Contribute!',

// Optional options for generating "Edit this page" link

// if your docs are in a different repo from your main project:
// docsRepo: 'vuejs/vuepress',
// if your docs are not at the root of the repo:
docsDir: 'docs',
// if your docs are in a specific branch (defaults to 'master'):
// docsBranch: 'master',
// defaults to false, set to true to enable
editLinks: true,
// custom text for edit link. Defaults to "Edit this page"
editLinkText: 'Help us improve this page!',
sidebar: [
['/', 'Welcome'],
'/guide',
{
title: 'Automatic Mode',
collapsable: false,
Expand All @@ -46,6 +33,7 @@ module.exports = {
'/debug-log',
'/foxy-gestures',
'/api',
'/limitations',
]
}
}
};
4 changes: 0 additions & 4 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,6 @@ The Automatic Mode will overwrite your standard ways of opening new tabs - even
- Middle Mouse: Always



**How to stay logged in on some websites in Automatic Mode?**


**How does it enhance my privacy?**
Every new Container [isolates local data that websites create](https://wiki.mozilla.org/Security/Contextual_Identity_Project/Containers#What_is_.28and_isn.27t.29_separated_between_Containers) (First- and Third-Party Cookies, localStorage, indexedDB, HTTP data cache, Image Cache and any other areas supported by originAttributes - except HSTS and OCSP) from each other - that makes it harder to track you and thus enhances your privacy. Also - when the last tab in an automatically created Temporary Container closes it gets deleted (after 15minutes by default, so you can Undo Close Tabs in that timeframe) - and with it all data that websites created inside that Container. As a bonus it'll strip referer information if you use configured Websites, Isolation or Mouse Clicks to open new Temporary Containers. Besides enhancing privacy containers also do something for security. They help preventing CSRF, clickjacking, or other attacks which rely on the presence of ambient credentials. For more details and comparisons with other privacy enhancing methods check the bottom of this description.

Expand Down
2 changes: 2 additions & 0 deletions docs/guide.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Guide

Enhance your privacy in Firefox with Temporary Containers

Since version 57 of Firefox - Codename Firefox Quantum - it is possible for Add-ons to activate the new Container feature without the need for the user to manually edit the browser configuration. Just install an Add-on that supports Containers and you're good to go.
Expand Down
9 changes: 9 additions & 0 deletions docs/limitations.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Limitations

* Disabled in "Private Windows" since Firefox doesn't support it
* Android Support is not possible since [Firefox doesn't support it](https://bugzilla.mozilla.org/show_bug.cgi?id=1398097)
* Mouse Clicks:
* In combination with [Multi-Account Containers](https://github.com/mozilla/multi-account-containers): Opening the same link multiple times in quick succession will probably not work as expected when the site is set to "Always open in $Container".
* Doesn't work on addons.mozilla.org (Firefox prevents content scripts there). If you assign addons.mozilla.org to "Always open in" with Multi-Account Containers you will see unexpected behavior since Add-ons, including Multi-Account Containers, are not allowed to block requests to addons.mozilla.org.
* In Automatic Mode:
* "No Container" Tab (Alt+N) and Window (Shift+Alt+C) must open about:blank due to Firefox API limitations and thus the address bar can't get focus when opening a new "No Container" tab.

0 comments on commit 74dd010

Please sign in to comment.