Docs
This commit is contained in:
stanzabird
parent
9775b85e9c
commit
4613108c3f
7 changed files with 301 additions and 0 deletions
22
docs/MR_howto.md
Normal file
22
docs/MR_howto.md
Normal file
|
|
@ -0,0 +1,22 @@
|
|||
# Merge Request (MR) how-to
|
||||
|
||||
This page is ment to document how to edit something, using an MR, on the [LibreWolf website](https://librewolf-community.gitlab.io/). I would perhaps recommend to read the _website_structure.md_ documentation first to get an overview of the website.
|
||||
|
||||
I'm a big proponent of editing the .md files right in the Gitlab website, no need to clone the files locally or any of that complicated stuff, it can all be done from the website, using a comfortable markdown editor which has a Write/Preview pane, bold and italics buttons, link buttons, most of the stuff we need. Also, it will make the MR merge process much easier and non-technical. As a bonus, because it's on the website one can edit pages from the web browser on mobile. The only downside to this is that we do not get _GnuPG cryptographically signed_ merge requests, but for .md files I guess that's really not a problem, the content is one-to-one with what people see on the website.
|
||||
|
||||
Ok, so that's what we're going to do, edit a page via the website. I will use the **docs / settings / _index.md** file as our running example.
|
||||
|
||||
## Edit process in practical steps
|
||||
|
||||
* We locate the .md file we want to edit in the source repository, in our example, we navigate to [this page](https://gitlab.com/librewolf-community/docs/-/blob/master/settings/_index.md).
|
||||
* We see a preview of the .md file, formatted roughly the way it looks on the site. We click the blue 'Edit' button.
|
||||
* It says: > You're not allowed to edit files in this project directly. Please fork this project, make your changes there, and submit a merge request.
|
||||
* Click 'Fork' right after that error message.
|
||||
* It will fork, and then it will take you to the online editor.
|
||||
* This editor is ideal, with a 'Write' tab that allows us to type in the markup text, and a 'Preview' tab that shows us how the page is going to look like when it appears on the website.
|
||||
* We do our editing, \<type-type-type-type> until we're done.
|
||||
* When done, we scroll down to the bottom of the page, and click the green 'Commit changes' button.
|
||||
* We now end up in the 'Submit Merge Request' page, where we explain in short form what the change is about. No need to be too strict about this.
|
||||
* We press the green 'Submit merge request' button.
|
||||
* We end up in the Merge Request page for our MR. You can always find all open MR's on the Github navigation to the left.
|
||||
* **Now it's out of our hands.** We wait until an admin/maintainer approves of our change, submit the change to the repository, and let the new version be generated and displayed on the website.
|
||||
18
docs/about_blurp.md
Normal file
18
docs/about_blurp.md
Normal file
|
|
@ -0,0 +1,18 @@
|
|||
# What is LibreWolf?
|
||||
|
||||
LibreWolf is just like Firefox, but it has all the recommended security setings and add-ons built in for you.
|
||||
|
||||
To be technical, LibreWolf, in essence, is just two files:
|
||||
|
||||
* [librewolf.cfg](https://gitlab.com/librewolf-community/settings/-/blob/master/librewolf.cfg) - All the recomended privacy settings.
|
||||
* [policies.json](https://gitlab.com/librewolf-community/settings/-/blob/master/distribution/policies.json) - Install privacy add-ons, remove all big tech search engines, and makes duckduckgo the default search engine.
|
||||
|
||||
That's it the rest should be your normal Firefox. [[DOWNLOAD SETUP]]
|
||||
|
||||
## What else do I need to know?
|
||||
|
||||
* Librewolf installs on your machine as administrator, so you can't change everything you want. Certain things we consider just too unsafe: and then we keep that setting locked.
|
||||
* Windows and macOS don't have automatic updates.
|
||||
* We do make changes to the firefox source, but these are minor things.
|
||||
* We don't like pocket. Sorry, you can't have your pocket. Or whatever cloud service, just the browser.
|
||||
* Updates are different per platform we deploy on.
|
||||
57
docs/addons-new.md
Normal file
57
docs/addons-new.md
Normal file
|
|
@ -0,0 +1,57 @@
|
|||
---
|
||||
title: Addons
|
||||
---
|
||||
|
||||
## uBlock Origin tweaks
|
||||
|
||||
[uBlock Origin](https://addons.mozilla.org/en-US/firefox/addon/ublock-origin/) comes bundled with LibreWolf. Also see their [wiki](https://github.com/gorhill/uBlock/wiki). We'll mention a few filter lists and entry points to the uBlock wiki.
|
||||
|
||||
Some essential uBlock Wiki pages to understand how uBlock Origin works:
|
||||
|
||||
* Easy mode, the default mode that we ship with the browser -> [Blocking mode:easy-mode](https://github.com/gorhill/uBlock/wiki/Blocking-mode:-easy-mode).
|
||||
* Dynamic filtering, suggested for enhanced protection -> [Dynamic filtering:quick guide](https://github.com/gorhill/uBlock/wiki/Dynamic-filtering:-quick-guide).
|
||||
* Medium mode, suggested for enhanced protection, might require to fix some websites manually -> [Blocking mode:medium-mode](https://github.com/gorhill/uBlock/wiki/Blocking-mode:-medium-mode).
|
||||
|
||||
|
||||
**Filter lists:**
|
||||
|
||||
- uBlock wiki: [Filter lists](https://github.com/gorhill/uBlock/wiki/Filter-lists-from-around-the-web): The uBlock wiki page on filter lists.
|
||||
- [adblock nocoin list](https://github.com/hoshsadiq/adblock-nocoin-list): Good blocklist against crypto-mining.
|
||||
- A collection of filter lists that are available on filterlists.com: [see this disussion page](https://github.com/DandelionSprout/adfilt/discussions/163).
|
||||
|
||||
|
||||
|
||||
## Recommended Addons
|
||||
|
||||
Recommended addons are not bundled and need to be installed manually, depending on your needs.
|
||||
|
||||
- [NoScript](https://addons.mozilla.org/en-US/firefox/addon/noscript/): NoScript Security Suite. Included into Tor Browser and comes highly recommended.
|
||||
- [uMatrix](https://addons.mozilla.org/en-US/firefox/addon/umatrix/): Note: uMatrix development has frozen, but it _does give more control_ over what gets blocked than NoScript, either uMatrix or NoScript are good choices.
|
||||
- [LocalCDN](https://addons.mozilla.org/en-US/firefox/addon/localcdn-fork-of-decentraleyes/): The successor to Decentraleyes.
|
||||
- [Bitwarden Password Manager](https://addons.mozilla.org/en-US/firefox/addon/bitwarden-password-manager/).
|
||||
|
||||
## Other Addons
|
||||
|
||||
### Privacy addons
|
||||
|
||||
- [ClearURLs](https://addons.mozilla.org/en-US/firefox/addon/clearurls/): Removes tracking elements from URLs.
|
||||
- [First Party Isolation](https://addons.mozilla.org/en-US/firefox/addon/first-party-isolation/): Enable/Disable FPI with the click of a button.
|
||||
- [Canvas Blocker](https://addons.mozilla.org/en-US/firefox/addon/canvasblocker/): Prevent some fingerprinting techniques.
|
||||
- [Smart Referer](https://addons.mozilla.org/en-US/firefox/addon/smart-referer/): Manage referer with a button. (Send referers only when staying on the same domain.)
|
||||
|
||||
### Container addons
|
||||
|
||||
- [Mozilla's Multi Account Containers](https://addons.mozilla.org/en-US/firefox/addon/multi-account-containers/): Manage containers and assign sites to specific container.
|
||||
- [Temporary-Containers](https://addons.mozilla.org/en-US/firefox/addon/temporary-containers/): Maximizing and automating container potential.
|
||||
- [Google Container](https://addons.mozilla.org/en-US/firefox/addon/google-container/): Open all Google sites in a container.
|
||||
- [Facebook Container](https://addons.mozilla.org/en-US/firefox/addon/facebook-container/): Open all Facebook sites in a container.
|
||||
- [Switch Containers](https://addons.mozilla.org/en-US/firefox/addon/switch-container/): Switching container for the current tab easily.
|
||||
|
||||
|
||||
### Other useful addons
|
||||
|
||||
- [Dark Reader](https://addons.mozilla.org/en-US/firefox/addon/darkreader/): Very populair addon, also useful for visually impaired people.
|
||||
- [Cookie Quick Manager](https://addons.mozilla.org/en-US/firefox/addon/cookie-quick-manager/): View and edit cookies.
|
||||
- [ProxySwitcheroo](https://addons.mozilla.org/en-US/firefox/addon/proxyswitcheroo/): Apply proxy settings in a click.
|
||||
- [Tabboo](https://addons.mozilla.org/en-US/firefox/addon/tabboo-session-manager/): Session manager.
|
||||
- [In My Pocket](https://addons.mozilla.org/en-US/firefox/addon/in-my-pocket/): For those needing pocket functionality.
|
||||
30
docs/dl_locations.md
Normal file
30
docs/dl_locations.md
Normal file
|
|
@ -0,0 +1,30 @@
|
|||
# download locations
|
||||
|
||||
* [[arch releases](https://gitlab.com/librewolf-community/browser/arch/-/releases)] -
|
||||
* [[linux releases](https://gitlab.com/librewolf-community/browser/linux/-/releases)] -
|
||||
* [[windows releases](https://gitlab.com/librewolf-community/browser/windows/-/releases)] -
|
||||
|
||||
# settings repository
|
||||
|
||||
* [[settings repository](https://gitlab.com/librewolf-community/settings)] - all _librewolf.cfg_ stuff.. ([issues](https://gitlab.com/librewolf-community/settings/-/issues))
|
||||
|
||||
# browser repositories
|
||||
|
||||
* [[common](https://gitlab.com/librewolf-community/browser/commons)] -> ([issues](https://gitlab.com/librewolf-community/browser/common/-/issues))
|
||||
* [[flatpack](https://gitlab.com/librewolf-community/browser/flatpak)] -> ([issues](https://gitlab.com/librewolf-community/browser/flatpak/-/issues))
|
||||
* [[linux](https://gitlab.com/librewolf-community/browser/linux)] -> ([issues](https://gitlab.com/librewolf-community/browser/linux/-/issues))
|
||||
* [[website](https://gitlab.com/librewolf-community/librewolf-community.gitlab.io)] - ([issues](https://gitlab.com/librewolf-community/librewolf-community.gitlab.io/-/issues))
|
||||
|
||||
# distro repositories
|
||||
|
||||
* [[arch](https://gitlab.com/librewolf-community/browser/arch)] -> ([issues](https://gitlab.com/librewolf-community/browser/arch/-/issues))
|
||||
* [[debian](https://gitlab.com/librewolf-community/browser/debian)] -> ([issues](https://gitlab.com/librewolf-community/browser/debian/-/issues))
|
||||
* [[gentoo](https://gitlab.com/librewolf-community/browser/gentoo)] -> ([issues](https://gitlab.com/librewolf-community/browser/gentoo/-/issues))
|
||||
* [[macos](https://gitlab.com/librewolf-community/browser/macos)] -> ([issues](https://gitlab.com/librewolf-community/browser/macos/-/issues))
|
||||
* [[windows](https://gitlab.com/librewolf-community/browser/windows)] -> ([issues](https://gitlab.com/librewolf-community/browser/windows/-/issues))
|
||||
|
||||
# community links
|
||||
|
||||
* If at all possible, pleasse go to the relevant 'issues' link and start discussing thing there.
|
||||
* [[reddit](https://www.reddit.com/r/LibreWolf/)]
|
||||
* [[gitter](https://gitter.im/librewolf-community/librewolf)]
|
||||
35
docs/drm_blurp.md
Normal file
35
docs/drm_blurp.md
Normal file
|
|
@ -0,0 +1,35 @@
|
|||
* This stuff below works for netflix and prime video.
|
||||
|
||||
fabrizio @fxbrit_gitlab 11:59
|
||||
|
||||
|
||||
I think we should remove from .cfg
|
||||
|
||||
defaultPref("media.gmp-manager.url", "data:text/plain,");
|
||||
defaultPref("media.gmp-manager.url.override", "data:text/plain,");
|
||||
defaultPref("media.gmp-manager.certs.2.commonName", "");
|
||||
defaultPref("media.gmp-manager.certs.1.commonName", "");
|
||||
as they are overkill
|
||||
|
||||
then we should also remove from .cfg
|
||||
|
||||
defaultPref("media.gmp-manager.updateEnabled", false);
|
||||
defaultPref("media.gmp-widevinecdm.autoupdate", false);
|
||||
defaultPref("media.gmp-eme-adobe.enabled", false);
|
||||
|
||||
as they do not appear by default in recent firefox versions and are introduced by our .cfg
|
||||
|
||||
With these modifications in place I went in about:config and did
|
||||
|
||||
defaultPref("media.eme.enabled", true);
|
||||
defaultPref("media.gmp-widevinecdm.enabled", true);
|
||||
defaultPref("media.gmp-widevinecdm.visible", true);
|
||||
defaultPref("media.gmp-provider.enabled", true);
|
||||
|
||||
when opening primevideo the video loaded with no required effort on my side
|
||||
|
||||
I think the only issue left, at least on prime video, is that the user agent makes it think that the browser is outdated and therefore it disables media reproduction at high quality
|
||||
I think I'm stuck at 720 or 1080 either
|
||||
|
||||
let's see if netflix works on my side
|
||||
yes! it works :)
|
||||
101
docs/website_overhaul.md
Normal file
101
docs/website_overhaul.md
Normal file
|
|
@ -0,0 +1,101 @@
|
|||
Hi all, this document tries to summarize all changes we would like to see in the website.
|
||||
|
||||
# https://gitlab.com/librewolf-community/librewolf-community.gitlab.io/-/blob/master/content/install.md
|
||||
url = https://librewolf-community.gitlab.io/install/
|
||||
|
||||
** Compiling from source **
|
||||
* Compiling from source is now possible for all versions of LibreWolf, just head over to the relevant repository, clone it, and read the README.md
|
||||
|
||||
** macOS: **
|
||||
* (Remove the current section completely.)
|
||||
* The macOS version builds from source, and has a .dmg available.
|
||||
* No automatic updating.
|
||||
* Have a link to the repository: https://gitlab.com/librewolf-community/browser/macos
|
||||
* Have a link to the releases: https://gitlab.com/librewolf-community/browser/macos/-/releases
|
||||
* Link to the _build guide_: https://gitlab.com/librewolf-community/browser/macos/-/blob/master/build_guide.md
|
||||
|
||||
** Windows: **
|
||||
* (Remove the current section completely.)
|
||||
* The Windows version builds from source, and has a -setup.exe available.
|
||||
* No automatic updating.
|
||||
* Have a link to the repository: https://gitlab.com/librewolf-community/browser/windows
|
||||
* Have a link to the releases: https://gitlab.com/librewolf-community/browser/windows/-/releases
|
||||
|
||||
# https://gitlab.com/librewolf-community/docs/-/blob/master/_index.md
|
||||
url = https://librewolf-community.gitlab.io/docs/
|
||||
|
||||
** Features **
|
||||
* Does LibreWolf still have an 'extensions firewall'?
|
||||
|
||||
** Download and Installation **
|
||||
* Remove the TODO and help needed line and please get in toch below windows.
|
||||
* Just the good, up to date links to the download loctions
|
||||
|
||||
** Contributions **
|
||||
* Typo: chance 'currently unsupported browser' into 'currently unsupported platform/operating system'.
|
||||
|
||||
# https://gitlab.com/librewolf-community/docs/-/blob/master/addons.md
|
||||
url = https://librewolf-community.gitlab.io/docs/addons/
|
||||
|
||||
* (Discussion pending.)
|
||||
|
||||
** Recommended Addons **
|
||||
* add as first one: [NoScript](https://addons.mozilla.org/en-US/firefox/addon/noscript/) Block JavaScript.
|
||||
* add second: [uMatrix](https://addons.mozilla.org/en-US/firefox/addon/umatrix/) Note: uMatrix development has frozen, but it gives more control than NoScript, use either uMatrix or NoScript.
|
||||
* add [LocalCDN](https://addons.mozilla.org/en-US/firefox/addon/localcdn-fork-of-decentraleyes/)
|
||||
* add Bitwarden add-on [add-on page](https://addons.mozilla.org/en-US/firefox/addon/bitwarden-password-manager/)
|
||||
* remove Browser Plugs Privacy Firewall (dead link)
|
||||
* remove uBlock stuff (see section below)
|
||||
|
||||
** new: uBlock Origin tweaks **
|
||||
* we should consider linking to ublock guide for advanced modes, and probably to at least one filter list that works against cryptomining and ones that removes url tracking (which is a good replacement to addons like clearURLs, don't track me google etc)
|
||||
* with regards to nano/nanoblocker: we should probably just remove it completely from the list; basically the new owners made it malicious.
|
||||
* good blocklist agains crypto-mining: [NoCoin adblock list](https://github.com/hoshsadiq/adblock-nocoin-list).
|
||||
* a collection of filter lists that are available on filterlists.com: https://github.com/DandelionSprout/adfilt/discussions/163
|
||||
* if you have the patience to fix a few websites when they break the medium mode is a really good balance between protection an usability imo: https://github.com/gorhill/uBlock/wiki/Blocking-mode:-medium-mode
|
||||
* I'll change it to add a 'ublock tweaks' section, could you pass a link to that Wiki? here it is: https://github.com/gorhill/uBlock/wiki
|
||||
|
||||
ok I collected what I would consider the essential links to understand how uBlock Origin works, I kept it pretty slim as it's already a lot to take:
|
||||
* easy mode, the default mode that we ship with the browser -> https://github.com/gorhill/uBlock/wiki/Blocking-mode:-easy-mode
|
||||
* how to add your own static filters, which should be included as we suggest filterlists -> https://github.com/gorhill/uBlock/wiki/Filter-lists-from-around-the-web
|
||||
* dynamic filtering, suggested for enhanced protection -> https://github.com/gorhill/uBlock/wiki/Dynamic-filtering:-quick-guide
|
||||
* medium mode, suggested for enhanced protection, might require to fix some websites manually ->
|
||||
https://github.com/gorhill/uBlock/wiki/Blocking-mode:-medium-mode
|
||||
|
||||
|
||||
|
||||
** Recommended Addons Settings **
|
||||
* remove 'cookie master' as it should be done in librewolf.cfg
|
||||
* remove 'User Agent Platform Spoofer', is done in librewolf.cfg
|
||||
* remove 'browser plugs privacy firewal' (dead link)
|
||||
* And the verbatim block below it is also obsolete.
|
||||
|
||||
** Other Addons **
|
||||
|
||||
*** Privacy addons ***
|
||||
* discussion
|
||||
* proposal: add a section 'Container addons' and put all container stuff in there: Google-Container, Facebook-Container, Mozilla-Multi-Account-Containers, Switch-Containers, Temporary-Containers)
|
||||
* remove noHTTP (builtin with latest firefox)
|
||||
* remove Decentraleyes (old not effective), replace with: [LocalCDN](https://addons.mozilla.org/en-US/firefox/addon/localcdn-fork-of-decentraleyes/)
|
||||
* remove Request Blocker
|
||||
* remove Cookie Quik Manager
|
||||
|
||||
*** Other useful addons ***
|
||||
* discussion
|
||||
* add [Dark Reader](https://addons.mozilla.org/en-US/firefox/addon/darkreader/). Can aid visually impaired people.
|
||||
* remove Dormancy, why would we want to recommend this?
|
||||
* Add custom search engine: why would we want this?
|
||||
* remove UndoCloseTabButton: why would we want to recommend this?
|
||||
* Advanced Github Notifier: why would we..
|
||||
* Shortkeys: why? also not security oriented.
|
||||
|
||||
# https://gitlab.com/librewolf-community/docs/-/blob/master/testing.md
|
||||
url = https://librewolf-community.gitlab.io/docs/testing/
|
||||
|
||||
** Security/Fingerprint **
|
||||
|
||||
* add [Cover Your Tracks](https://coveryourtracks.eff.org/), perhaps a bit prominently.
|
||||
|
||||
|
||||
|
||||
|
||||
38
docs/website_structure.md
Normal file
38
docs/website_structure.md
Normal file
|
|
@ -0,0 +1,38 @@
|
|||
# website structure
|
||||
|
||||
The [LibreWolf website](https://librewolf-community.gitlab.io/) is built using the Gitlab machinery. The website is generated from .md (markdown) files (see [markdown guide](https://www.markdownguide.org/)). The bulk of a page on the website is generated from .md into .html by the [hugo static site generator](https://gohugo.io/). Of course, the website contains grahics/css/javascript.
|
||||
|
||||
So we have our website divided into two parts:
|
||||
* Repository: [LibreWolf-Community.gitlab.io](https://gitlab.com/librewolf-community/librewolf-community.gitlab.io) - The repository that contains the instructions for Hugo/Github how to generate and host the website. Low-level repository.
|
||||
* Repository: [Docs](https://gitlab.com/librewolf-community/docs) - The actual documentation we're going to work with, on [this url](https://librewolf-community.gitlab.io/docs) in the website. High-level repository.
|
||||
|
||||
## Low-level repository:
|
||||
|
||||
Within the low-level repository, there are two interesting subdirectories. First, the [static](https://gitlab.com/librewolf-community/librewolf-community.gitlab.io/-/tree/master/static) folder contains all the images, javascript, fonts and css for the website.
|
||||
|
||||
Second, the [content](https://gitlab.com/librewolf-community/librewolf-community.gitlab.io/-/tree/master/content) folder. It contains an **install.md** with _installation instructions for the user_ wanting to try, install, or upgrade LibreWolf. Second interesting item: _docs @ 22e7df52_ which is a link to the actual 'Docs' repository. And this is how the low-level part of the website 'knows how to find' the High-level part.
|
||||
|
||||
As you can tell, I would be much more happy if that install.md would actually be in the Docs repository, but ok. (Logically, install.md is where you end up clicking 'install' on the main page, and 'docs' is where you end up clicking the 'documentation' button/link.) Let's go to the high-level repository.
|
||||
|
||||
## High-level repository:
|
||||
|
||||
The main repository folder has all the .md files right there, and all of them are interesting, except for the _readme.md_ and _licence.md_.
|
||||
|
||||
It contains only one subfolder (settings) with one file in it: _index.md. This looks like an inconsistency, but the idea is probably to have quite a lot of explanation and documentation and pages on the settings in LibreWolf (which form the core of LibreWolf). You can see this substructure reflected in the site navigation on top (this is all done by _Hugo_).
|
||||
|
||||
How does the mapping from .md files to .html pages work? Well, every .md page maps directly to an .html url on the website. So if you create a new file, it will get picked up automatically by the Hugo site generator, and a navigation link will get created. If you want to do that, the first line must be of the form:
|
||||
|
||||
---
|
||||
title: My page
|
||||
---
|
||||
|
||||
# My page
|
||||
|
||||
Hi there, this is my new page. Lorem ipsum etc.
|
||||
|
||||
That's basically all about the website structure. All the pages count, and their title: on the first section tells you what their 'navigation' title is. If you delete such an .md file, it disappears from the site.
|
||||
|
||||
### My other notes/topics
|
||||
|
||||
* I feel that the **install.md** file is critical. This is what people who do not read click on to 'just give me LibreWolf'. This is especially true for Windows/Apple users. The Linux crowd is different and much more hardcore. In a way we want to make things easy clickable for the Windows/Apple users, and clear and consise for the Linux users.
|
||||
* Second, the **docs / _index.md** file is critical. This is where people land when they click on 'Documentation'. I'm not sure what they would want to read first, but it should point the way to the documentation in general and how it is structured.
|
||||
Loading…
Add table
Reference in a new issue