Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #41

Merged
merged 1 commit into from
Jan 5, 2025
Merged

Update README.md #41

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<h1 align="center">Mailu-OIDC</h1>
<p align="center">
Multi-container mail server landscape<br />
featuring OpenID Connect authentication
featuring OpenID Connect authentication.
</p>

---
Expand All @@ -24,8 +24,8 @@ Most of the documentation is available [below](#getting-started), and on the [Ma
> [!NOTE]
> This fork is extended by an OpenID Connect implementation to enable single
> sign-on user session handling and authentication using OIDC providers. The
> fork is maintained by [Heviat](https://heviat.com), a German cloud computing
> company based in Potsdam. Feel free to contribute to this repository!
> fork is maintained by [Heviat](https://heviat.com), a group of German-speaking software
> developers excited about tech innovation. Feel free to contribute to this repository!

## Features

Expand Down Expand Up @@ -55,6 +55,11 @@ Main features include:
5. Add the [required OIDC environment variables](#setting-up-variables) to the `mailu.env` file
6. Continue with the official setup guide [from here](https://mailu.io/2024.06/compose/setup.html#tls-certificates)

> [!TIP]
> We are currently working on our own configuration assistant to improve the
> setup experience for `Mailu-OIDC`. You will also be able to use it for `Mailu`
> without our OIDC implementation.

### Replacing Docker Images

To use the OIDC-enabled Mailu images, the Docker images have to be downloaded
Expand Down
Loading