Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wallix/PEPS
Innovative Open source Email + File sharing
https://github.com/wallix/PEPS
Last synced: about 1 month ago
JSON representation
Innovative Open source Email + File sharing
- Host: GitHub
- URL: https://github.com/wallix/PEPS
- Owner: wallix
- License: agpl-3.0
- Created: 2013-11-08T19:43:56.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2018-05-04T12:19:58.000Z (over 6 years ago)
- Last Synced: 2024-08-02T12:47:33.932Z (4 months ago)
- Language: Python
- Homepage:
- Size: 95.7 KB
- Stars: 700
- Watchers: 61
- Forks: 114
- Open Issues: 56
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.html
Awesome Lists containing this project
- awesome-repositories - wallix/PEPS - Innovative Open source Email + File sharing (Python)
- awesome-starred - wallix/PEPS - Innovative Open source Email + File sharing (others)
README
**Warning: This product is not maintained!**
**Following the acquisition of MLstate by WALLIX, the core technology of PEPS has become [DataPeps](https://datapeps.com), a generic E2EE framework that can be integrated in any application.**
The content below is kept as a reference, please do not use the following code and project.
PEPS
====
PEPS was an innovative open source email and collaboration server.
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.
# 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](http://github.com/MLstate/PEPS/wiki/About) and its [roadmap](http://github.com/MLstate/PEPS/wiki/Roadmap). We also have a [FAQ](http://github.com/MLstate/PEPS/wiki/FAQ).
This repository contains the source of the PEPS containers.
[PEPS application source](https://github.com/MLstate/PEPS-source) is available from a [separate repository](https://github.com/MLstate/PEPS-source) under the Affero GPL License.
# Installation guide
The deployment of a single PEPS server is made easy with [Docker](http://docker.io).
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](mailto:[email protected]).
## Docker containers
First install Docker on your server. If you are new to Docker, you can use Docker-ready linux instances at [DigitalOcean](https://www.digitalocean.com/community/tutorials/how-to-run-your-own-mail-server-and-file-storage-with-peps-on-ubuntu-14-04) 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:
```sh
# 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:
```sh
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:
```sh
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](http://github.com/MLstate/PEPS/wiki/User-Manual)
- [Admin Manual](http://github.com/MLstate/PEPS/wiki/Admin-Manual)
- [Developer Manual](http://github.com/MLstate/PEPS/wiki/Developer-Manual)
- [Operator Manual](https://github.com/MLstate/PEPS/wiki/Operator-Manual)
# Twitter contacts
- Project created by [@henri_opa](https://twitter.com/henri_opa) at [MLstate](http://mlstate.com)
- Design/UX by [@tweetfr](https://twitter.com/tweetfr)
- Main developers: [henrichataing](https://github.com/henrichataing), [Aqua-Ye](https://github.com/Aqua-Ye), [cedricss](https://github.com/cedricss), [matbd](https://github.com/matbd), [nrs135](https://github.com/nrs135)