grommunio Admin API

grommunio Admin API is the central API component of grommunio managing appliance(s), domain(s), users(s) and more. grommunio API orchestrates any components and architectures required to operate and manage the entire grommunio stack.

Overview

• About
  • Built with
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Status
• Support
• Project assistance
• Contributing
• Security
• Coding style
• License

---

About grommunio Admin API

• OpenAPI 3.0 based REST API and interactive CLI
• Web-based access via grommunio Admin Web
• Management of grommunio components
• User, group and mailing list management
• User synchronization with LDAP-capable backends
• Account-retrieval via fetchmail
• Public Folder management
• Role management with System, Organization and Domain roles
• Tenant management with organizations and domains
• Configuration through grommunio-dbconf
• Realtime connection status incl. mobile devices
• Log Viewer
• Mail transport queue and Task queue
• Distributable, compatible with load balancers such as haproxy, apisix, KEMP and others
• Secure, with extended security checks and CSRF tokens

Getting Started

Prerequisites

• uwsgi application server with uwsgi-python3 plugin
• MySQL or MariaDB database server as central storage (as used and set up by gromox)
• python3-pyexmdb for gromox store management (provided by libexmdbpp)
• Recommended: a web server with a working TLS configuration (e.g. nginx)

Installation

• Install required packages listed in the Pipfile, either as system packages or in a virtual environment
• Deploy admin-api at a location of your choice, such as /usr/share/grommunio-admin-api
• Configure database connection
• Customize configuration as needed
• Run the main.py file with uwsgi (example configuration, documentation)

Usage

• Use the grommunio Admin API CLI reference for operation from https://docs.grommunio.com/man/grommunio-admin.html

or

• Use your API client to generate calls, based on OpenAPI specification

Support

• Support is available through grommunio GmbH and its partners.
• grommunio Admin API community is available here: grommunio Community

For direct contact to the maintainers (for example to supply information about a security-related responsible disclosure), you can contact grommunio directly at dev@grommunio.com

Contributing

First off, thanks for taking the time to contribute! Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make will benefit everybody else and are greatly appreciated.

Please read our contribution guidelines, and thank you for being involved!

Security

grommunio Admin API follows good practices of security. grommunio constantly monitors security related issues. grommunio Admin API is provided "as is" without any warranty. For professional support options through subscriptions, head over to grommunio.

For more information and to report security issues, please refer to our security documentation.

Coding style

This repository follows coding style loosely based on PEP8 standard (exception: maximum line width of 127).

License

This project is licensed under the GNU Affero General Public License v3.

See LICENSE for more information.