Thanks to visit codestin.com
Credit goes to github.com

Skip to content

LPD-64975 Technical Task | [Composer] Add mail server support #99

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

Merged
merged 2 commits into from
Sep 16, 2025
Merged

LPD-64975 Technical Task | [Composer] Add mail server support #99

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2f23e2f
LPD-64975 add mail support
annasuszter Sep 15, 2025
854fe3e
correct incomplete sentence
annasuszter Sep 16, 2025
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
31 changes: 30 additions & 1 deletion README.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,11 @@ To shut down the environment, run `./gradlew stop`.
- [Configure Elasticsearch ports](#configure-elasticsearch-ports)
- Supports Liferay clustering OOTB

### Mail features overview

- [Enable mail service](#enable-mail-service)
- [Configure mail service ports](#configure-mail-service-ports)

### Webserver features overview

- [Enable NGINX (HTTP)](#enable-nginx-http)
Expand Down Expand Up @@ -256,7 +261,7 @@ lr.docker.environment.service.enabled[elasticsearch]=true
#### Configure Elasticsearch ports

The Elasticsearch HTTP and transport ports can be configured by the `ELASTICSEARCH_HTTP_PORT` and
the `ELASTICSEARCH_TRANSPORT_PORT` respectively in the `ports.env` file.
the `ELASTICSEARCH_TRANSPORT_PORT` environment variables respectively in the `ports.env` file.

`ports.env`:

Expand All @@ -265,6 +270,30 @@ ELASTICSEARCH_HTTP_PORT=9200-9209
ELASTICSEARCH_TRANSPORT_PORT=9300-9309
```

### Mail features

#### Enable the mail service

Set the `lr.docker.environment.service.enabled[mail]` property to `true` or `1` in `gradle.properties`.

`gradle.properties`:

```properties
lr.docker.environment.service.enabled[mail]=true
```

#### Configure mail service ports

The mail service's web and SMTP ports can be configured by the `MAIL_WEB_PORT` and `MAIL_SMTP_PORT` environment variables
respectively in the `ports.env` file.

`ports.env`:

```dotenv
MAIL_WEB_PORT=1080
MAIL_SMTP_PORT=1025
```

### Webserver Features

#### Enable NGINX (HTTP)
Expand Down
16 changes: 16 additions & 0 deletions compose-recipes/mail/clustering.mail.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
services:
liferay-cluster-node:
environment:
- LIFERAY_MAIL_PERIOD_SESSION_PERIOD_MAIL_PERIOD_POP_NUMBER3__PERIOD_HOST=localhost
- LIFERAY_MAIL_PERIOD_SESSION_PERIOD_MAIL_PERIOD_POP_NUMBER3__PERIOD_PASSWORD=
- LIFERAY_MAIL_PERIOD_SESSION_PERIOD_MAIL_PERIOD_POP_NUMBER3__PERIOD_PORT=110
- LIFERAY_MAIL_PERIOD_SESSION_PERIOD_MAIL_PERIOD_POP_NUMBER3__PERIOD_USER=
- LIFERAY_MAIL_PERIOD_SESSION_PERIOD_MAIL_PERIOD_SMTP_PERIOD_AUTH=false
- LIFERAY_MAIL_PERIOD_SESSION_PERIOD_MAIL_PERIOD_SMTP_PERIOD_HOST=mail
- LIFERAY_MAIL_PERIOD_SESSION_PERIOD_MAIL_PERIOD_SMTP_PERIOD_PASSWORD=
- LIFERAY_MAIL_PERIOD_SESSION_PERIOD_MAIL_PERIOD_SMTP_PERIOD_PORT=${MAIL_SMTP_PORT}
- LIFERAY_MAIL_PERIOD_SESSION_PERIOD_MAIL_PERIOD_SMTP_PERIOD_STARTTLS_PERIOD_ENABLE=false
- LIFERAY_MAIL_PERIOD_SESSION_PERIOD_MAIL_PERIOD_SMTP_PERIOD_USER=admin@liferay.com
- LIFERAY_MAIL_PERIOD_SESSION_PERIOD_MAIL_PERIOD_STORE_PERIOD_PROTOCOL=smtp
- LIFERAY_MAIL_PERIOD_SESSION_PERIOD_MAIL_PERIOD_TRANSPORT_PERIOD_PROTOCOL=smtp
- LIFERAY_MAIL_PERIOD_SEND_PERIOD_BLACKLIST=
19 changes: 19 additions & 0 deletions compose-recipes/mail/liferay.mail.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
services:
liferay:
depends_on:
mail:
condition: service_healthy
environment:
- LIFERAY_MAIL_PERIOD_SESSION_PERIOD_MAIL_PERIOD_POP_NUMBER3__PERIOD_HOST=localhost
- LIFERAY_MAIL_PERIOD_SESSION_PERIOD_MAIL_PERIOD_POP_NUMBER3__PERIOD_PASSWORD=
- LIFERAY_MAIL_PERIOD_SESSION_PERIOD_MAIL_PERIOD_POP_NUMBER3__PERIOD_PORT=110
- LIFERAY_MAIL_PERIOD_SESSION_PERIOD_MAIL_PERIOD_POP_NUMBER3__PERIOD_USER=
- LIFERAY_MAIL_PERIOD_SESSION_PERIOD_MAIL_PERIOD_SMTP_PERIOD_AUTH=false
- LIFERAY_MAIL_PERIOD_SESSION_PERIOD_MAIL_PERIOD_SMTP_PERIOD_HOST=mail
- LIFERAY_MAIL_PERIOD_SESSION_PERIOD_MAIL_PERIOD_SMTP_PERIOD_PASSWORD=
- LIFERAY_MAIL_PERIOD_SESSION_PERIOD_MAIL_PERIOD_SMTP_PERIOD_PORT=${MAIL_SMTP_PORT}
- LIFERAY_MAIL_PERIOD_SESSION_PERIOD_MAIL_PERIOD_SMTP_PERIOD_STARTTLS_PERIOD_ENABLE=false
- LIFERAY_MAIL_PERIOD_SESSION_PERIOD_MAIL_PERIOD_SMTP_PERIOD_USER=admin@liferay.com
- LIFERAY_MAIL_PERIOD_SESSION_PERIOD_MAIL_PERIOD_STORE_PERIOD_PROTOCOL=smtp
- LIFERAY_MAIL_PERIOD_SESSION_PERIOD_MAIL_PERIOD_TRANSPORT_PERIOD_PROTOCOL=smtp
- LIFERAY_MAIL_PERIOD_SEND_PERIOD_BLACKLIST=
12 changes: 12 additions & 0 deletions compose-recipes/mail/service.mail.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
services:
mail:
container_name: ${NAMESPACE}-mail
healthcheck:
interval: 10s
retries: 10
test: nc -z localhost 1025 || exit 1
timeout: 5s
image: maildev/maildev
ports:
- "${MAIL_WEB_PORT}:1080"
- "${MAIL_SMTP_PORT}:1025"
1 change: 1 addition & 0 deletions gradle.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ lr.docker.environment.compose.files=
lr.docker.environment.service.enabled[db2]=false
lr.docker.environment.service.enabled[elasticsearch]=false
lr.docker.environment.service.enabled[liferay]=true
lr.docker.environment.service.enabled[mail]=false
lr.docker.environment.service.enabled[mariadb]=false
lr.docker.environment.service.enabled[mysql]=false
lr.docker.environment.service.enabled[postgres]=false
Expand Down
3 changes: 3 additions & 0 deletions ports.env
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,8 @@ DATABASE_PORT=54321-54330
ELASTICSEARCH_HTTP_PORT=9200-9209
ELASTICSEARCH_TRANSPORT_PORT=9300-9309

MAIL_WEB_PORT=1080
MAIL_SMTP_PORT=1025

WEBSERVER_HTTP_PORT=80
WEBSERVER_HTTPS_PORT=443
Loading