Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/censortracker/censortracker

Censor Tracker is a censorship circumvention extension for Google Chrome and Mozilla Firefox.
https://github.com/censortracker/censortracker

addon brave bypass bypass-censorship censorship censortracker chrome chromium dpi-filtering extension firefox firefox-addon microsoft-edge mozilla opera proxy vpn webextension

Last synced: 4 days ago
JSON representation

Censor Tracker is a censorship circumvention extension for Google Chrome and Mozilla Firefox.

Awesome Lists containing this project

README

        

![Build](https://github.com/censortracker/censortracker/workflows/Build/badge.svg?branch=master)
![Netlify](https://img.shields.io/netlify/1137e5c4-6b68-42a3-ab0b-804b92c482b8)
[![CodeFactor](https://www.codefactor.io/repository/github/censortracker/censortracker/badge)](https://www.codefactor.io/repository/github/censortracker/censortracker)
[![Chrome Web Store](https://img.shields.io/chrome-web-store/v/gaidoampbkcknofoejhnhbhbhhifgdop)](https://chrome.google.com/webstore/detail/censor-tracker/gaidoampbkcknofoejhnhbhbhhifgdop)
[![Mozilla Add-on](https://img.shields.io/amo/v/censor-tracker)](https://addons.mozilla.org/ru/firefox/addon/censor-tracker/)

**Censor Tracker** is a censorship circumvention extension for [Google Chrome] and [Mozilla Firefox].

[**English**](./README.md) | [**Russian**](./README_RU.md)

[](https://chrome.google.com/webstore/detail/censor-tracker/gaidoampbkcknofoejhnhbhbhhifgdop)
[](https://addons.mozilla.org/ru/firefox/addon/censor-tracker/)

Features
========

Censor Tracker provides a lot of useful features, here are the most important:

- Configurable proxy
- Country-specific proxying
- Custom proxying list
- Censorship-resistant itself
- Warns about websites that transfer data to third parties

Permissions
===========

Censor Tracker requires the following permissions:

- `alarms` to support periodic tasks
- `activeTab` to detect IDO websites
- `management` to be able to detect permission conflicts
- `notifications` to show notifications
- `proxy` to configure and use Censor Tracker proxy servers
- `scripting` to inject content scripts into websites
- `storage` to save preferences
- `unlimitedStorage` to save the database of blocked websites
- `webNavigation` for handling requests
- `http://*/*` and `https://*/*` to proxy any website, retrieve the list of proxy servers, and detect the user's country

Requirements
============

Censor Tracker works with following versions of browsers:

- Mozilla Firefox 98 or higher
- Chromium (Google Chrome, Brave, Edge, Opera etc.) 94 or higher

Development
===========

Prerequisites
-------------

Make sure you have required versions of `node` and `npm`, which are:

- `node v17.4.0` or higher
- `npm 8.3.1` or higher

Optionally, you may like:

- [`nvm`](https://github.com/nvm-sh/nvm)

The build was tested only on the following operating systems:

- `Ubuntu 19.10`
- `macOS Catalina v10.15.7`

We don't guarantee that Censor Tracker will work on outdated versions of browsers,
so make sure you're using the latest ones.

We've tested Censor Tracker on the following versions:

- Mozilla Firefox 98 or higher
- Google Chrome 94 or higher

Installation
------------

Firstly, you will need to install dependencies:

~ npm install

Now you can build an extension for Chrome like this:

~ npm run build:chrome
~ cd dist/chrome

and for Firefox, like this:

~ npm run build:firefox
~ cd dist/firefox

**Troubleshooting**: If you're getting error on building an extension using `npm`, please make sure that your
shell supports per-command environment variables (i.e something like this `NODE_ENV=production npm run build:firefox:prod`)

Going to production
-------------------

You can build a production version of the extension for Chrome like this:

~ npm run build:chrome:prod
~ npm run release:chrome
~ cd release/chrome

and for Firefox like this:

~ npm run build:firefox:prod
~ npm run release:firefox
~ cd release/firefox

License
=======

Censor Tracker is licensed under the MIT License. See [LICENSE] for more
information.

[DPI]: https://en.wikipedia.org/wiki/Deep_packet_inspection
[LICENSE]: https://github.com/censortracker/censortracker/blob/master/LICENSE
[Google Chrome]: https://www.google.com/chrome/
[Mozilla Firefox]: https://www.mozilla.org/en-US/firefox/new/