snappymail/README.md
2020-08-10 11:32:05 +02:00

106 lines
3.8 KiB
Markdown

<div align="center">
<a href="https://github.com/RainLoop/rainloop-webmail">
<img width="200" heigth="200" src="https://www.rainloop.net/static/img/logo-256x256-tiny.png">
</a>
<br>
<h1>RainLoop Webmail</h1>
<br>
<p>
Simple, modern &amp; fast web-based email client.
</p>
<p>
Modest system requirements, decent performance, simple installation and upgrade, no database required
- all these make RainLoop Webmail a perfect choice for your email solution.
</p>
<h2></h2>
<br>
</div>
For more information about the product, check [rainloop.net](https://www.rainloop.net/).
Information about installing the product, check the [wiki page](https://github.com/the-djmaze/rainloop-webmail/wiki/Installation-instructions).
And don't forget to read the [official documentation](https://www.rainloop.net/docs/).
## License
**RainLoop Webmail (Community edition)** is released under
**GNU AFFERO GENERAL PUBLIC LICENSE Version 3 (AGPL)**.
http://www.gnu.org/licenses/agpl-3.0.html
Copyright (c) 2019 Rainloop Team
## Modifications
This fork has the following changes:
* Privacy/GDPR friendly (no: Social, Gravatar, Facebook, Google, Twitter, DropBox, OwnCloud, X-Mailer)
* Admin uses password_hash/password_verify
* Auth failed attempts written to syslog
* Added Fail2ban instructions
* ES2015
* PHP 7.3+ required
* PHP mbstring extension required
* PHP replaced pclZip with ZipArchive
* PHP yaml extension else use the old Spyc
* Removed BackwardCapability (class \RainLoop\Account)
* Removed ChangePassword (plugins won't work)
* Removed OAuth support
* Removed POP3 support
* Removed background video support
* Removed Sentry (Application Monitoring and Error Tracking Software)
* Replaced gulp-uglify with gulp-terser
* CRLF => LF line endings
* Ongoing removal of old JavaScript code (things are native these days)
### Removal of old JavaScript
This fork uses downsized/simplified versions of scripts and has no support for Internet Explorer.
The result is faster and smaller download code (good for mobile networks).
Things might work in Edge 15-18, Firefox 47-62 and Chrome 54-68 due to one polyfill for array.flat().
* Replaced jQuery with jQuery.slim
* Replaced ProgressJS with simple native dropin
* Removed pikaday
* Removed underscore
* Removed polyfills
* Removed Modernizr
* Removed nanoscroll
* Removed jquery-scrollstop
* Removed jquery-mousewheel
* Removed matchmedia-polyfill
* Removed momentjs (localization still used)
|js/* |1.14.0 |native |gzip 1.14 |gzip |
|----------- |--------: |--------: |--------: |--------: |
|admin.js |2.130.942 |1.210.331 | 485.481 | 297.342 |
|app.js |4.184.455 |2.950.323 | 932.725 | 689.992 |
|boot.js | 671.522 | 46.647 | 169.502 | 16.138 |
|libs.js | 647.614 | 437.187 | 194.728 | 133.728 |
|polyfills.js | 325.834 | 0 | 71.825 | 0 |
|TOTAL js |7.960.367 |4.644.488 |1.854.261 |1.137.200 |
|js/min/* |1.14.0 |native |gzip 1.14 |gzip |
|--------------- |--------: |--------: |--------: |--------: |
|admin.min.js | 252.147 | 156.113 | 73.657 | 44.598 |
|app.min.js | 511.202 | 383.798 |140.462 |101.450 |
|boot.min.js | 66.007 | 5.970 | 22.567 | 2.420 |
|libs.min.js | 572.545 | 392.436 |176.720 |123.484 |
|polyfills.min.js | 32.452 | 0 | 11.312 | 0 |
|TOTAL js/min |1.434.353 | 938.317 |424.718 |271.952 |
496.036 bytes (152.766 gzip) is not much, but it feels faster.
|css/* |1.14.0 |native |
|-------------- |--------: |--------: |
|app.css | 340.334 | 272.858 |
|app.min.css | 274.791 | 216.893 |
### PHP73 branch
There's a branch with only the PHP 7.3 changes at
https://github.com/the-djmaze/rainloop-webmail/tree/php73