mwasyou / peps

Open source Email + File sharing with end-to-end encryption

PEPS

Innovative open source email and collaboration server with transparent end-to-end encryption.

Main Features
Clean UX/UI
Messages
File sharing
Newsfeed
Client-side encryption
New internal message protocol
Extensible
RESTful APIs
Powered by Node.js
Data in MongoDB
Open Source

This open source portal enables you to download and install PEPS on your own server. To get generic information on PEPS, go to PEPS website.

The project is active as of November 2015 and our goal is to stabilize Peps as a priority.

Why PEPS?

PEPS is an open source email, file sharing and collaboration server that intends to fullfil the need for high-quality on-premises software that could rival with top-notch SaaS products such as Gmail or Dropbox, and innovate with new features.

PEPS is built to be extensible thanks to complete APIs and we aim at creating an ecosystem of compatible apps and services.

Please read more about PEPS and its roadmap. We also have a FAQ.

This repository contains the source of the PEPS containers. PEPS application source is available from a separate repository under the Affero GPL License.

Installation guide

The deployment of a single PEPS server is made easy with Docker. You should have your server up and running in 30 minutes. PEPS uses technologies that can scale up, but this will require some more work or you can contact our company.

Docker containers

First install Docker on your server. If you are new to Docker, you can use Docker-ready linux instances at DigitalOcean or similar services. You must have at least 2 Gb RAM for your PEPS instance.

To build the Docker containers and run on a Docker instance, just type:

# Just in case, install make
apt-get install make
# Clone the repository
git clone https://github.com/MLstate/PEPS
cd PEPS

# Configure your domain name
echo YOUR_DOMAIN_NAME > domain

# Build the containers
make build
make certificate # or install existing certificates server.key and server.crt
# Run the containers
make run

To later stop, start and remove containers, you can use:

make stop
make start
make rm

System Configuration

PEPS runs by default using HTTPS. The only major pre-requisites are that you should have installed server.crt and server.key in the $(PEPS_ETC) directory (by default /etc/peps) which is shared by several containers. If you want to start quickly with a self-signed certificate, type:

make certificate

before running make run.

Note that the same certificates are used for the HTTPS server and the SMTPS services.

PEPS Configuration

You should now be able to run the PEPS server at https://YOUR_DOMAIN_NAME and connect to it, you then need to:

1. Set up the 'admin' password at first launch and accept the license
2. Head to the "Users" tab in the topbar
3. Create users, teams, and go!

Documentation

Manuals for both users and admins are available in form of the PEPS wiki:

• User Manual
• Admin Manual
• Developer Manual
• Operator Manual

Twitter contacts

• Project created by @henri_opa at MLstate
• Design/UX by @tweetfr
• Main developers: henrichataing, Aqua-Ye, cedricss, matbd, nrs135