Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Skip to content
README.md 7.3 KiB
Newer Older
uazo's avatar
uazo committed
<a href="https://github.com/uazo/cromite/releases/latest">
  <img src="https://img.shields.io/github/v/release/uazo/cromite" alt="current Cromite release" title="current Cromite release" />
</a>
<br>

[![Build Cromite](https://github.com/uazo/cromite/actions/workflows/build_cromite.yaml/badge.svg)](https://github.com/uazo/cromite/actions/workflows/build_cromite.yaml)

uazo's avatar
uazo committed
# Cromite (a Bromite fork) - Take back your browser
uazo's avatar
uazo committed

uazo's avatar
uazo committed
<a href="https://www.cromite.org">
  <img title="Cromite - take back your browser!" src="https://www.cromite.org/app_icon.png" width="96" alt="Bromite" />
uazo's avatar
uazo committed
<br>
csagan5's avatar
csagan5 committed

### **** the documentation is a Work in progress (not the browser :) ****
uazo's avatar
uazo committed

uazo's avatar
uazo committed
Cromite is a [Chromium](https://www.chromium.org/Home) fork based on [Bromite](https://github.com/bromite/bromite) with built-in support for ad blocking and an eye for privacy.
uazo's avatar
uazo committed
Cromite is available for Android arm64-v8a, arm32-v7a and x86_64, Nougat and above (Minimum v7.0, API level 24), Windows and Linux 64bit.
csagan5's avatar
csagan5 committed

csagan5's avatar
csagan5 committed
For the Frequently Asked Questions see [F.A.Q.](./FAQ.md).

csagan5's avatar
csagan5 committed
For documentation see the [wiki](https://github.com/bromite/bromite/wiki).

csagan5's avatar
csagan5 committed
# Goals

uazo's avatar
uazo committed
Cromite's goal is to
- limit the features built into the browser that can be used as a platform for tracking users' habits, and, if it is not technically possible, disable them and leave it up to the user to choose whether to re-enable them
- limit the close integration between the browser and its manufacturer
- not let the excellent research work done by csagan5 with Bromite be lost
csagan5's avatar
csagan5 committed

uazo's avatar
uazo committed
In addition, Cromite would like to promote greater integration with other non-profit, open source browsers, encouraging closer collaboration with others, and attempt to integrate them directly into Chromium once they have reached an appropriate level of maturity.
csagan5's avatar
csagan5 committed

csagan5's avatar
csagan5 committed
# Features
uazo's avatar
uazo committed
see [Features](https://github.com/uazo/cromite/blob/master/FEATURES.md)
csagan5's avatar
csagan5 committed

uazo's avatar
uazo committed
Cromite's privacy features, including anti-fingerprinting mitigations (which are not comprehensive), **are not to be considered useful for journalists and people living in countries with freedom limitations**, please look at [Tor Browser](https://www.torproject.org/download/) in such cases.
Please note that this project is not free of bugs and that changing the behaviour of a browser can be risky and not without problems.
uazo's avatar
uazo committed
# Releases
csagan5's avatar
csagan5 committed

Carmelo Messina's avatar
Carmelo Messina committed
All built versions are available as [releases](https://github.com/uazo/cromite/releases).
csagan5's avatar
csagan5 committed

uazo's avatar
uazo committed
Cromite is currently built for ARM64, x86 (Android SDK version 23+) and Windows x64.
You will automatically receive notifications about new updates (and be able to install them) via the auto updater functionality (enabled by default), see [related wiki page](https://github.com/bromite/bromite/wiki/AutomaticUpdates).
uazo's avatar
uazo committed
### F-droid

Official F-droid repo url:
https://www.cromite.org/fdroid/repo/?fingerprint=49F37E74DEE483DCA2B991334FB5A0200787430D0B5F9A783DD5F13695E9517B
uazo's avatar
uazo committed

### Auto-update setup for windows

1. Download https://github.com/henrypp/chrlauncher/releases
2. Create a `chrlauncher.ini`

```
[chrlauncher]

# Custom Chromium update URL (string):
ChromiumUpdateUrl=https://github.com/uazo/cromite/releases/latest/download/updateurl.txt

# Command line for Chromium (string):
# note --user-data-dir= works better if path is absolute
# See here: http://peter.sh/experiments/chromium-command-line-switches/
ChromiumCommandLine=--user-data-dir=".\User Data" --no-default-browser-check

# to enable full logging in c:\temp\log.txt (daily rotate, no automatic deletion)
# ChromiumCommandLine=--enable-logging --v=0 --log-file=C:\temp\log.txt --user-data-dir=".\User Data" --no-default-browser-check

# Chromium executable file name (string):
ChromiumBinary=chrome.exe

# Chromium binaries directory (string):
# Relative (to chrlauncher directory) or full path (env. variables supported).
ChromiumDirectory=.\bin
```

### Enable network process sandbox in windows
I don't include any setups because I don't like the experience of not knowing what they do, so you must manually run this command on first installation:
```
cd <where_is_the_exe>
icacls . /grant "*S-1-15-2-2:(OI)(CI)(RX)"
```
see https://github.com/uazo/bromite-buildtools/issues/51
### Enable AppContainer for renderer process in windows
you can activate the 'RendererAppContainer' flag from the command line with
```
  --enable-features=RendererAppContainer
```

uazo's avatar
uazo committed
## (TODO) Integrity and authenticity

You can verify the integrity of a downloaded APK file from this project with any `sha256sum`-compatible tool by downloading the corresponding `brm_X.Y.Z.sha256.txt` or `chr_X.Y.Z.sha256.txt` file, where X.Y.Z is the release version number. Example:
```
$ sha256sum --check brm_68.0.3440.54.sha256.txt
arm64_SystemWebView.apk: OK
arm64_ChromePublic.apk: OK
arm64_ChromeModernPublic.apk: OK
```

You can verify authenticity, e.g. that the author ([csagan5](https://github.com/csagan5)) released the file, by using gpg2:
```
$ gpg2 --quiet --verify brm_68.0.3440.54.sha256.txt.asc
gpg: assuming signed data in 'brm_68.0.3440.54.sha256.txt'
gpg: Signature made Sun 08 Jul 2018 04:22:52 PM CEST using RSA key ID D85DC0C5
gpg: Good signature from "csagan5 <32685696+csagan5@users.noreply.github.com>"
```

You can download csagan5's public GnuPG key from here: [csagan5.asc](./csagan5.asc).

uazo's avatar
uazo committed
# (TODO) How to build
csagan5's avatar
csagan5 committed

csagan5's avatar
csagan5 committed
The [Bromite main repository](https://github.com/bromite/bromite) contains tags for each corresponding Chromium release (see https://chromium.googlesource.com/chromium/src.git).
csagan5's avatar
csagan5 committed

Please refer to [official Chromium build documentation](https://www.chromium.org/developers/how-tos/get-the-code) to get started on how to build Chromium; if you can build Chromium for Android, you can build Bromite.

csagan5's avatar
csagan5 committed
The Chromium version tag used as base for the patches is available here: [RELEASE](./build/RELEASE); this is always corresponding to the git tag for every release.
The GN args used to build Bromite are available here: [bromite.gn_args](./build/bromite.gn_args).
csagan5's avatar
csagan5 committed
The patches are to be applied second the order specified in the `bromite_patches_list.txt` file (you can use `git am`).
uazo's avatar
uazo committed
# (TODO) Contributing
Carl's avatar
Carl committed

Please submit issues following the issue template; beware that GitHub does not display the templates from mobile.

csagan5's avatar
csagan5 committed
Patches are welcome and accepted if they match the project goals.

Universaliser's avatar
Universaliser committed
For any usage or development discussion please use GitHub Discussions: https://github.com/uazo/cromite/discussions
csagan5's avatar
csagan5 committed
# Credits

csagan5's avatar
csagan5 committed
* [Chromium project](https://www.chromium.org/Home) and developers
uazo's avatar
uazo committed
* [Bromite](https://github.com/bromite/bromite)
  * [Iridium project](https://github.com/iridium-browser) for some patches
  * [ungoogled-chromium](https://github.com/Eloston/ungoogled-chromium) for some patches
  * [ungoogled-chromium-android](https://github.com/ungoogled-software/ungoogled-chromium-android) for some patches
  * [GrapheneOS](https://github.com/GrapheneOS) for some security patches
  * [Inox patchset](https://github.com/gcarq/inox-patchset) for some patches (via ungoogled-chromium)
  * [Brave Browser](https://github.com/brave/brave-core) for some patches

# (TODO) License
csagan5's avatar
csagan5 committed

csagan5's avatar
csagan5 committed
The patches published as part of the Bromite project are released under [GNU GPL v3](./LICENSE).
csagan5's avatar
csagan5 committed

[version-image]: https://img.shields.io/github/release/bromite/bromite.svg?style=flat-square
[version-url]: https://github.com/bromite/bromite/releases/latest
csagan5's avatar
csagan5 committed
[license-image]: https://img.shields.io/github/license/bromite/bromite.svg
[license-url]: https://github.com/bromite/bromite/blob/master/LICENSE