https://github.com/mailvelope/mailvelope

Browser extension for OpenPGP encryption with Webmail
https://github.com/mailvelope/mailvelope

Last synced: about 2 months ago
JSON representation

Browser extension for OpenPGP encryption with Webmail

• Host: GitHub
• URL: https://github.com/mailvelope/mailvelope
• Owner: mailvelope
• License: agpl-3.0
• Created: 2012-08-24T19:48:19.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2024-10-18T18:43:24.000Z (about 2 months ago)
• Last Synced: 2024-10-20T05:36:13.943Z (about 2 months ago)
• Language: JavaScript
• Homepage:
• Size: 35.2 MB
• Stars: 1,694
• Watchers: 93
• Forks: 213
• Open Issues: 284
• Metadata Files:
  • Readme: Readme.md
  • Changelog: Changelog.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred - mailvelope/mailvelope - Browser extension for OpenPGP encryption with Webmail (others)

README

        
# Mailvelope

[![Build Status](https://travis-ci.org/mailvelope/mailvelope.svg?branch=master)](https://travis-ci.org/mailvelope/mailvelope)

Mailvelope is a browser extension for Google Chrome and Firefox that allows secure email communication based on the OpenPGP standard. It can be configured to work with arbitrary Webmail provider.

## OpenPGP backends

Mailvelope uses the following OpenPGP implementation

  - [OpenPGP.js](http://openpgpjs.org/) for the Chrome Extension and for the Firefox Addon

## Installation

Mailvelope is available in the Chrome Web Store:

https://chrome.google.com/webstore/detail/kajibbejlbohfaggdiogboambcijhkke

For Firefox you can get it from addons.mozilla.org:

https://addons.mozilla.org/en/firefox/addon/mailvelope/

Or check the [releases](https://github.com/mailvelope/mailvelope/releases) section for latest builds of Firefox and Chrome installation packages.

## Client API

You can find the current [API Documentation](https://mailvelope.github.io/mailvelope) on GitHub pages. The version will correspond to the current master branch. A demo page with unit tests is available at: [https://demo.mailvelope.com](https://demo.mailvelope.com).

## Build instructions

If you don’t have grunt installed, yet:

    npm install -g grunt-cli

and then get and build the sources:

    git clone https://github.com/mailvelope/mailvelope.git

    cd mailvelope

    npm ci && grunt prod

#### Chrome

    grunt dist-cr

The Chrome extension will be in `dist/mailvelope.chrome.zip`.

#### Firefox

    grunt dist-ff

The Firefox web extension will be in `dist/mailvelope.firefox.zip`.

#### Development

Update your local repository:

    # inside mailvelope folder

    git checkout dev

    git pull origin dev && grunt

    # continue with 'grunt dist-cr' or 'grunt dist-ff'

There are a few more tasks/tools available:

* watch source code for changes and recompile if needed

    `grunt watch`

* test the firefox plugin

  ```

  node_modules/web-ext/bin/web-ext run --source-dir=./build/firefox

  ```

  It is possible to reload the plugin on changes, run the `grunt watch` task on another console terminal

* reset repository

    `grunt clean`

## Website

https://www.mailvelope.com

## Licence

Use of this source code is governed by the GNU AFFERO GENERAL PUBLIC LICENSE that can be found in the LICENSE file.

## About

Contact: Thomas Oberndörfer 

Twitter: [@mailvelope](https://twitter.com/mailvelope)

Contributors: see [list on GitHub](https://github.com/mailvelope/mailvelope/graphs/contributors)