From 320bdd0f77ceaffa3551ad721dabf164ca445ccc Mon Sep 17 00:00:00 2001 From: mdecimus Date: Thu, 28 Dec 2023 15:27:01 +0100 Subject: [PATCH] Updated README --- .github/ISSUE_TEMPLATE/bug_report.yml | 3 +- README.md | 56 ++++++++++++++++++++------- 2 files changed, 43 insertions(+), 16 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index e22630a..a7e7290 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -35,8 +35,7 @@ body: options: - v0.5.x - v0.4.x - - v0.3.x - - v0.2.0 or lower + - v0.3.0 or lower validations: required: true - type: dropdown diff --git a/README.md b/README.md index d3710af..4175700 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,40 @@ -# Stalwart JMAP Server - -[![Build](https://github.com/stalwartlabs/jmap-server/actions/workflows/build.yml/badge.svg)](https://github.com/stalwartlabs/jmap-server/actions/workflows/build.yml) -[![License: AGPL v3](https://img.shields.io/badge/License-AGPL_v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0) -[![](https://img.shields.io/discord/923615863037390889?label=Chat)](https://discord.gg/jtgtCNj66U) -[![](https://img.shields.io/twitter/follow/stalwartlabs)](https://twitter.com/stalwartlabs) -[![](https://img.shields.io/mastodon/follow/109929667531941122)](https://mastodon.social/@stalwartlabs) +

+ + + +
+ Stalwart JMAP Server +

+ +

+ Secure & Modern JMAP Server 🛡️ +

+ +

+ + continuous integration + + + License: AGPL v3 + + + Documentation + +
+ + Mastodon + + + Twitter + +
+ + Discord + + + Matrix + +

**Stalwart JMAP** is an open-source JSON Meta Application Protocol server designed to be secure, fast, robust and scalable. JMAP is a modern protocol for synchronising data such as mail, calendars, or contacts that makes much more efficient use of network resources. @@ -16,24 +46,22 @@ Key features: - JMAP Mail ([RFC 8621](https://datatracker.ietf.org/doc/html/rfc8621)) - JMAP over WebSocket ([RFC 8887](https://datatracker.ietf.org/doc/html/rfc8887)) - JMAP for Sieve Scripts ([DRAFT-SIEVE-13](https://www.ietf.org/archive/id/draft-ietf-jmap-sieve-13.html)). -- **Flexible**: - - **LDAP** directory and **SQL** database authentication. +- **Flexible and scalable**: + - Pluggable storage backends with **RocksDB**, **FoundationDB**, **PostgreSQL**, **mySQL**, **SQLite**, **S3-Compatible**, **Redis** and **ElasticSearch** support. + - **Internal**, **LDAP** and **SQL** database authentication. - Built-in [SMTP](https://github.com/stalwartlabs/smtp-server) server for local delivery and JMAP Email Submissions. - Full-text search available in 17 languages. - Disk quotas. - Sieve scripting language with support for all [registered extensions](https://www.iana.org/assignments/sieve-extensions/sieve-extensions.xhtml). - Email aliases, mailing lists, subaddressing and catch-all addresses support. - Integration with **OpenTelemetry** to enable monitoring, tracing, and performance analysis. -- **Secure**: +- **Secure and robust**: - Encryption at rest with **S/MIME** or **OpenPGP**. - Built-in Spam and Phishing filter. - OAuth 2.0 [authorization code](https://www.rfc-editor.org/rfc/rfc8628) and [device authorization](https://www.rfc-editor.org/rfc/rfc8628) flows. - Access Control Lists (ACLs). - Rate limiting. -- **Robust and scalable**: - - **FoundationDB** or **SQLite** database backends. - - **S3-compatible** blob storage support. - - Memory safe (thanks to Rust). + - Memory safe (thanks to Rust). ## Get Started