This webapp uses yarn and Vite for development
and requires Node.js 22.22 or newer.
To build for production, this webapp uses a Makefile with GNU Make
yarn
yarn start
The development server runs on http://localhost:3000 and proxies /api/v1 and
/config.json to a running grommunio-admin-api (default http://localhost:8080).
To use a different backend, set ADMIN_API_URL:
ADMIN_API_URL=http://192.168.1.10:8080 yarn start
DEV_HOST and DEV_PORT change the address the development server listens on
(default 127.0.0.1:3000).
yarn typecheck
yarn lint
Run this command to create files for distribution.
The app is built into /build, the distribution tarball is created in /dist.
The version shown in the app is taken from VITE_BUILD_VERSION (set by the Makefile).
By default the app assumes it is served at the root of its domain
(https://mail.example.com/). To run it under a subpath instead
(https://mail.example.com/admin/), only the <base href="/"> tag
in index.html needs to be adapted.
In order to get the correct configuration for production, create a config.json in
/etc/grommunio-admin-common/config.json.
Attributes which are manually set in config.json will overwrite the default values,
otherwise the defaults are used.
Following attributes are available:
-
devMode:booleanFor development, enables redux logger (default:false) -
tokenRefreshInterval:intSets token refresh interval in seconds. (default:86400(24h)) -
defaultDarkMode:booleanIftrue, the app will be set to dark mode, if not explicitly set by the user/browser -
defaultTheme:stringName of the default theme to use. Available themes: grommunio, green, purple, magenta (default: "grommunio") -
loadAntispamData:booleanWhether or not to load antispam data in the dashboard (default:true) -
rspamdWebAddress:StringUrl of production rspamd server (default:'') -
mailWebAddress:StringUrl of production mail server (default:'') -
chatWebAddress:StringUrl of production chat server (default:'') -
videoWebAddress:StringUrl of production video server (default:'') -
fileWebAddress:StringUrl of production file server (default:'') -
archiveWebAddress:StringUrl of production archive server (default:'') -
searchAttributes:Array<String>Array of strings, possible LDAP Search attributes -
customImages:Object: This object can be used to white-label the app. That includes logos, icons and background images. It is possible to create separate sets of images for different hostnames. Each hostname is the key of an object, which has following keys:logo: The logo in the login formlogoLight: The logo in the expanded drawericon: The icon in the collapsed drawerbackground: The background image in light modebackgroundDark: The background image in dark modefavicon: The site's favicon
Each of these keys must be an URL to an image file. If none of the hostnames matches, the special hostname
*will be used as a fallback.An example
customImagesobject looks like this:"customImages": { "localhost": { "logo": "url.to/logo.png", "logoLight": "url.to/light/logo.png", "icon": "url.to/light/icon.svg", "background": "url.to/background.svg", "backgroundDark": "url.to/dark/background.svg", "favicon": "url.to/fancy/favicon.png" }, "example.com": { "logo": "anotherUrl.to/logo.png", "logoLight": "anotherUrl.to/light/logo.png", "icon": "anotherUrl.to/light/icon.svg" }, "*": { "logo": "defaultUrl.to/logo.png", "logoLight": "defaultUrl.to/light/logo.png", "icon": "defaultUrl.to/light/icon.svg" } }
As you can see, it is not necessary to overwrite every image, but the hostnames need to be accurate.
- Support is available through grommunio GmbH and its partners.
- grommunio Admin web 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
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!
grommunio Admin web follows good practices of security. grommunio constantly monitors security related issues. grommunio Admin web 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.
This repository follows coding style loosely based on PEP8 standard (exception: maximum line width of 127).
This project is licensed under the GNU Affero General Public License v3.
See LICENSE for more information.