From 30b0bb1d5bd95e843b3ec931a8b0f3d848e4eb9d Mon Sep 17 00:00:00 2001 From: pradip Date: Tue, 1 Apr 2025 12:12:34 +0545 Subject: [PATCH 1/2] test: replace inbucket with mailpit in deployment --- deployments/examples/ocis_full/.env | 8 ++++--- deployments/examples/ocis_full/mailpit.yml | 26 ++++++++++++++++++++++ 2 files changed, 31 insertions(+), 3 deletions(-) create mode 100644 deployments/examples/ocis_full/mailpit.yml diff --git a/deployments/examples/ocis_full/.env b/deployments/examples/ocis_full/.env index 1e537445488..c34cc4de7dd 100644 --- a/deployments/examples/ocis_full/.env +++ b/deployments/examples/ocis_full/.env @@ -227,14 +227,16 @@ WOPISERVER_ONLYOFFICE_DOMAIN= # Inbucket is a mail catcher tool for testing purposes. # DO NOT use in Production. # Note: the leading colon is required to enable the service. -#INBUCKET=:inbucket.yml +# INBUCKET=:inbucket.yml # email server (in this case inbucket acts as mail catcher). # Domain for Inbucket. Defaults to "mail.owncloud.test". -INBUCKET_DOMAIN= +# INBUCKET_DOMAIN= +MAILPIT=:mailpit.yml +MAILPIT_DOMAIN= ## IMPORTANT ## # This MUST be the last line as it assembles the supplemental compose files to be used. # ALL supplemental configs must be added here, whether commented or not. # Each var must either be empty or contain :path/file.yml -COMPOSE_FILE=docker-compose.yml${OCIS:-}${TIKA:-}${S3NG:-}${S3NG_MINIO:-}${COLLABORA:-}${MONITORING:-}${IMPORTER:-}${CLAMAV:-}${ONLYOFFICE:-}${INBUCKET:-}${EXTENSIONS:-}${UNZIP:-}${DRAWIO:-}${JSONVIEWER:-}${PROGRESSBARS:-}${EXTERNALSITES:-} +COMPOSE_FILE=docker-compose.yml${OCIS:-}${TIKA:-}${S3NG:-}${S3NG_MINIO:-}${COLLABORA:-}${MONITORING:-}${IMPORTER:-}${CLAMAV:-}${ONLYOFFICE:-}${INBUCKET:-}${EXTENSIONS:-}${UNZIP:-}${DRAWIO:-}${JSONVIEWER:-}${PROGRESSBARS:-}${EXTERNALSITES:-}${MAILPIT:-} diff --git a/deployments/examples/ocis_full/mailpit.yml b/deployments/examples/ocis_full/mailpit.yml new file mode 100644 index 00000000000..412980f8db1 --- /dev/null +++ b/deployments/examples/ocis_full/mailpit.yml @@ -0,0 +1,26 @@ +services: + ocis: + environment: + NOTIFICATIONS_SMTP_HOST: mailpit + NOTIFICATIONS_SMTP_PORT: 1025 + NOTIFICATIONS_SMTP_SENDER: oCIS notifications + NOTIFICATIONS_SMTP_USERNAME: notifications@${OCIS_DOMAIN:-ocis.owncloud.test} + NOTIFICATIONS_SMTP_INSECURE: "true" + + mailpit: + image: axllent/mailpit:v1.22.3 + networks: + - ocis-net + ports: + - "8025:8025" # Web UI + - "1025:1025" # SMTP + labels: + - "traefik.enable=true" + - "traefik.http.routers.mailpit.entrypoints=https" + - "traefik.http.routers.mailpit.rule=Host(`${MAILPIT_DOMAIN:-mail.owncloud.test}`)" + - "traefik.http.routers.mailpit.tls.certresolver=http" + - "traefik.http.routers.mailpit.service=mailpit" + - "traefik.http.services.mailpit.loadbalancer.server.port=8025" + logging: + driver: ${LOG_DRIVER:-local} + restart: always From bf4f12ec52bfdee97ee114e4919e57f81f1e1087 Mon Sep 17 00:00:00 2001 From: pradip Date: Tue, 1 Apr 2025 14:54:01 +0545 Subject: [PATCH 2/2] test: remove and replace trace of inbucket with mailpit --- .../ocis_full/master.yml | 4 +-- .../ocis_full/onlyoffice-master.yml | 4 +-- .../ocis_full/onlyoffice-rolling.yml | 4 +-- .../ocis_full/production.yml | 4 +-- .../ocis_full/rolling.yml | 4 +-- .../ocis_full/s3-rolling.yml | 4 +-- deployments/examples/ocis_full/.env | 18 ++++------ deployments/examples/ocis_full/inbucket.yml | 34 ------------------- .../ocis_full/{mailpit.yml => mailserver.yml} | 14 ++++---- docs/ocis/deployment/continuous_deployment.md | 2 +- docs/ocis/deployment/ocis_full.md | 2 +- .../invitations/md-sources/example-realm.json | 4 +-- 12 files changed, 30 insertions(+), 68 deletions(-) delete mode 100644 deployments/examples/ocis_full/inbucket.yml rename deployments/examples/ocis_full/{mailpit.yml => mailserver.yml} (56%) diff --git a/deployments/continuous-deployment-config/ocis_full/master.yml b/deployments/continuous-deployment-config/ocis_full/master.yml index 99a52c2498e..5f181e555c1 100644 --- a/deployments/continuous-deployment-config/ocis_full/master.yml +++ b/deployments/continuous-deployment-config/ocis_full/master.yml @@ -37,9 +37,9 @@ COMPANION_IMAGE: owncloud/uppy-companion:3.12.13-owncloud WOPISERVER_DOMAIN: wopiserver.ocis.master.owncloud.works COLLABORA_DOMAIN: collabora.ocis.master.owncloud.works - INBUCKET_DOMAIN: mail.ocis.master.owncloud.works + MAIL_SERVER_DOMAIN: mail.ocis.master.owncloud.works DEMO_USERS: "true" - COMPOSE_FILE: docker-compose.yml:ocis.yml:tika.yml:collabora.yml:web_extensions/extensions.yml:web_extensions/unzip.yml:web_extensions/importer.yml:inbucket.yml:monitoring_tracing/monitoring.yml + COMPOSE_FILE: docker-compose.yml:ocis.yml:tika.yml:collabora.yml:web_extensions/extensions.yml:web_extensions/unzip.yml:web_extensions/importer.yml:mailserver.yml:monitoring_tracing/monitoring.yml - name: monitoring git_url: https://github.com/owncloud-devops/monitoring-tracing-client.git ref: master diff --git a/deployments/continuous-deployment-config/ocis_full/onlyoffice-master.yml b/deployments/continuous-deployment-config/ocis_full/onlyoffice-master.yml index 164f5949d2b..a65491ce443 100644 --- a/deployments/continuous-deployment-config/ocis_full/onlyoffice-master.yml +++ b/deployments/continuous-deployment-config/ocis_full/onlyoffice-master.yml @@ -37,9 +37,9 @@ COMPANION_IMAGE: owncloud/uppy-companion:3.12.13-owncloud WOPISERVER_ONLYOFFICE_DOMAIN: wopiserver-oo.ocis-onlyoffice.master.owncloud.works ONLYOFFICE_DOMAIN: onlyoffice.ocis-onlyoffice.master.owncloud.works - INBUCKET_DOMAIN: mail.ocis-onlyoffice.master.owncloud.works + MAIL_SERVER_DOMAIN: mail.ocis-onlyoffice.master.owncloud.works DEMO_USERS: "true" - COMPOSE_FILE: docker-compose.yml:ocis.yml:tika.yml:onlyoffice.yml:web_extensions/extensions.yml:web_extensions/unzip.yml:web_extensions/importer.yml:inbucket.yml:monitoring_tracing/monitoring-oo.yml + COMPOSE_FILE: docker-compose.yml:ocis.yml:tika.yml:onlyoffice.yml:web_extensions/extensions.yml:web_extensions/unzip.yml:web_extensions/importer.yml:mailserver.yml:monitoring_tracing/monitoring-oo.yml - name: monitoring git_url: https://github.com/owncloud-devops/monitoring-tracing-client.git ref: master diff --git a/deployments/continuous-deployment-config/ocis_full/onlyoffice-rolling.yml b/deployments/continuous-deployment-config/ocis_full/onlyoffice-rolling.yml index a886e4787f6..6919d9a1673 100644 --- a/deployments/continuous-deployment-config/ocis_full/onlyoffice-rolling.yml +++ b/deployments/continuous-deployment-config/ocis_full/onlyoffice-rolling.yml @@ -37,9 +37,9 @@ COMPANION_IMAGE: owncloud/uppy-companion:3.12.13-owncloud WOPISERVER_ONLYOFFICE_DOMAIN: wopiserver-oo.ocis-onlyoffice.rolling.owncloud.works ONLYOFFICE_DOMAIN: onlyoffice.ocis-onlyoffice.rolling.owncloud.works - INBUCKET_DOMAIN: mail.ocis-onlyoffice.rolling.owncloud.works + MAIL_SERVER_DOMAIN: mail.ocis-onlyoffice.rolling.owncloud.works DEMO_USERS: "true" - COMPOSE_FILE: docker-compose.yml:ocis.yml:tika.yml:onlyoffice.yml:web_extensions/extensions.yml:web_extensions/unzip.yml:web_extensions/importer.yml:inbucket.yml:monitoring_tracing/monitoring-oo.yml + COMPOSE_FILE: docker-compose.yml:ocis.yml:tika.yml:onlyoffice.yml:web_extensions/extensions.yml:web_extensions/unzip.yml:web_extensions/importer.yml:mailserver.yml:monitoring_tracing/monitoring-oo.yml - name: monitoring git_url: https://github.com/owncloud-devops/monitoring-tracing-client.git ref: master diff --git a/deployments/continuous-deployment-config/ocis_full/production.yml b/deployments/continuous-deployment-config/ocis_full/production.yml index a0dde882351..2fdd884a72e 100644 --- a/deployments/continuous-deployment-config/ocis_full/production.yml +++ b/deployments/continuous-deployment-config/ocis_full/production.yml @@ -36,9 +36,9 @@ COMPANION_IMAGE: owncloud/uppy-companion:3.12.13-owncloud WOPISERVER_DOMAIN: wopiserver.ocis.production.owncloud.works COLLABORA_DOMAIN: collabora.ocis.production.owncloud.works - INBUCKET_DOMAIN: mail.ocis.production.owncloud.works + MAIL_SERVER_DOMAIN: mail.ocis.production.owncloud.works DEMO_USERS: "true" - COMPOSE_FILE: docker-compose.yml:ocis.yml:tika.yml:collabora.yml:web_extensions/extensions.yml:web_extensions/unzip.yml:web_extensions/importer.yml:inbucket.yml:monitoring_tracing/monitoring.yml + COMPOSE_FILE: docker-compose.yml:ocis.yml:tika.yml:collabora.yml:web_extensions/extensions.yml:web_extensions/unzip.yml:web_extensions/importer.yml:mailserver.yml:monitoring_tracing/monitoring.yml - name: monitoring git_url: https://github.com/owncloud-devops/monitoring-tracing-client.git ref: master diff --git a/deployments/continuous-deployment-config/ocis_full/rolling.yml b/deployments/continuous-deployment-config/ocis_full/rolling.yml index d08b02e69f3..ddb08f7a5fb 100644 --- a/deployments/continuous-deployment-config/ocis_full/rolling.yml +++ b/deployments/continuous-deployment-config/ocis_full/rolling.yml @@ -37,9 +37,9 @@ COMPANION_IMAGE: owncloud/uppy-companion:3.12.13-owncloud WOPISERVER_DOMAIN: wopiserver.ocis.rolling.owncloud.works COLLABORA_DOMAIN: collabora.ocis.rolling.owncloud.works - INBUCKET_DOMAIN: mail.ocis.rolling.owncloud.works + MAIL_SERVER_DOMAIN: mail.ocis.rolling.owncloud.works DEMO_USERS: "true" - COMPOSE_FILE: docker-compose.yml:ocis.yml:tika.yml:collabora.yml:web_extensions/extensions.yml:web_extensions/unzip.yml:web_extensions/importer.yml:inbucket.yml:monitoring_tracing/monitoring.yml + COMPOSE_FILE: docker-compose.yml:ocis.yml:tika.yml:collabora.yml:web_extensions/extensions.yml:web_extensions/unzip.yml:web_extensions/importer.yml:mailserver.yml:monitoring_tracing/monitoring.yml - name: monitoring git_url: https://github.com/owncloud-devops/monitoring-tracing-client.git ref: master diff --git a/deployments/continuous-deployment-config/ocis_full/s3-rolling.yml b/deployments/continuous-deployment-config/ocis_full/s3-rolling.yml index fb32524fc51..41a0e1a246e 100644 --- a/deployments/continuous-deployment-config/ocis_full/s3-rolling.yml +++ b/deployments/continuous-deployment-config/ocis_full/s3-rolling.yml @@ -37,10 +37,10 @@ COMPANION_IMAGE: owncloud/uppy-companion:3.12.13-owncloud WOPISERVER_DOMAIN: wopiserver.ocis-s3.rolling.owncloud.works COLLABORA_DOMAIN: collabora.ocis-s3.rolling.owncloud.works - INBUCKET_DOMAIN: mail.ocis-s3.rolling.owncloud.works + MAIL_SERVER_DOMAIN: mail.ocis-s3.rolling.owncloud.works MINIO_DOMAIN: minio.ocis-s3.rolling.owncloud.works DEMO_USERS: "true" - COMPOSE_FILE: docker-compose.yml:ocis.yml:s3ng.yml:minio.yml:tika.yml:collabora.yml:web_extensions/extensions.yml:web_extensions/unzip.yml:web_extensions/importer.yml:inbucket.yml:monitoring_tracing/monitoring.yml + COMPOSE_FILE: docker-compose.yml:ocis.yml:s3ng.yml:minio.yml:tika.yml:collabora.yml:web_extensions/extensions.yml:web_extensions/unzip.yml:web_extensions/importer.yml:mailserver.yml:monitoring_tracing/monitoring.yml - name: monitoring git_url: https://github.com/owncloud-devops/monitoring-tracing-client.git ref: master diff --git a/deployments/examples/ocis_full/.env b/deployments/examples/ocis_full/.env index c34cc4de7dd..ee9c19f7c8e 100644 --- a/deployments/examples/ocis_full/.env +++ b/deployments/examples/ocis_full/.env @@ -97,7 +97,7 @@ MINIO_DOMAIN= # Define SMPT settings if you would like to send Infinite Scale email notifications. # For more details see: # https://doc.owncloud.com/ocis/latest/deployment/services/s-list/notifications.html -# NOTE: when configuring Inbucket, these settings have no effect, see inbucket.yml for details. +# NOTE: when configuring mail server (i.e., Mailpit), these settings have no effect, see mailserver.yml for details. # SMTP host to connect to. SMTP_HOST= # Port of the SMTP host to connect to. @@ -223,20 +223,16 @@ ONLYOFFICE_DOMAIN= WOPISERVER_ONLYOFFICE_DOMAIN= -### Inbucket Settings ### -# Inbucket is a mail catcher tool for testing purposes. +### Mail Server Settings ### +# Mailpit serves as both an email server and a catcher tool for testing purposes. # DO NOT use in Production. # Note: the leading colon is required to enable the service. -# INBUCKET=:inbucket.yml -# email server (in this case inbucket acts as mail catcher). -# Domain for Inbucket. Defaults to "mail.owncloud.test". -# INBUCKET_DOMAIN= - -MAILPIT=:mailpit.yml -MAILPIT_DOMAIN= +# MAIL_SERVER=:mailserver.yml +# Domain for mail server. Defaults to "mail.owncloud.test". +MAIL_SERVER_DOMAIN= ## IMPORTANT ## # This MUST be the last line as it assembles the supplemental compose files to be used. # ALL supplemental configs must be added here, whether commented or not. # Each var must either be empty or contain :path/file.yml -COMPOSE_FILE=docker-compose.yml${OCIS:-}${TIKA:-}${S3NG:-}${S3NG_MINIO:-}${COLLABORA:-}${MONITORING:-}${IMPORTER:-}${CLAMAV:-}${ONLYOFFICE:-}${INBUCKET:-}${EXTENSIONS:-}${UNZIP:-}${DRAWIO:-}${JSONVIEWER:-}${PROGRESSBARS:-}${EXTERNALSITES:-}${MAILPIT:-} +COMPOSE_FILE=docker-compose.yml${OCIS:-}${TIKA:-}${S3NG:-}${S3NG_MINIO:-}${COLLABORA:-}${MONITORING:-}${IMPORTER:-}${CLAMAV:-}${ONLYOFFICE:-}${EXTENSIONS:-}${UNZIP:-}${DRAWIO:-}${JSONVIEWER:-}${PROGRESSBARS:-}${EXTERNALSITES:-}${MAIL_SERVER:-} diff --git a/deployments/examples/ocis_full/inbucket.yml b/deployments/examples/ocis_full/inbucket.yml deleted file mode 100644 index 5b8c6087b2d..00000000000 --- a/deployments/examples/ocis_full/inbucket.yml +++ /dev/null @@ -1,34 +0,0 @@ ---- -services: - ocis: - environment: - NOTIFICATIONS_SMTP_HOST: inbucket - NOTIFICATIONS_SMTP_PORT: 2500 - NOTIFICATIONS_SMTP_SENDER: oCIS notifications - NOTIFICATIONS_SMTP_USERNAME: notifications@${OCIS_DOMAIN:-ocis.owncloud.test} - # the mail catcher uses self signed certificates - NOTIFICATIONS_SMTP_INSECURE: "true" - - inbucket: - image: inbucket/inbucket - # changelog: https://github.com/inbucket/inbucket/blob/main/CHANGELOG.md - networks: - - ocis-net - entrypoint: - - /bin/sh - command: [ "-c", "apk add openssl; openssl req -subj '/CN=inbucket.test' -x509 -sha256 -nodes -days 365 -newkey rsa:2048 -keyout /tmp/server.key -out /tmp/server.crt; /start-inbucket.sh" ] - environment: - INBUCKET_SMTP_TLSENABLED: "true" - INBUCKET_SMTP_TLSPRIVKEY: /tmp/server.key - INBUCKET_SMTP_TLSCERT: /tmp/server.crt - INBUCKET_STORAGE_MAILBOXMSGCAP: 1000 - labels: - - "traefik.enable=true" - - "traefik.http.routers.inbucket.entrypoints=https" - - "traefik.http.routers.inbucket.rule=Host(`${INBUCKET_DOMAIN:-mail.owncloud.test}`)" - - "traefik.http.routers.inbucket.tls.certresolver=http" - - "traefik.http.routers.inbucket.service=inbucket" - - "traefik.http.services.inbucket.loadbalancer.server.port=9000" - logging: - driver: ${LOG_DRIVER:-local} - restart: always diff --git a/deployments/examples/ocis_full/mailpit.yml b/deployments/examples/ocis_full/mailserver.yml similarity index 56% rename from deployments/examples/ocis_full/mailpit.yml rename to deployments/examples/ocis_full/mailserver.yml index 412980f8db1..b398f61911f 100644 --- a/deployments/examples/ocis_full/mailpit.yml +++ b/deployments/examples/ocis_full/mailserver.yml @@ -1,13 +1,13 @@ services: ocis: environment: - NOTIFICATIONS_SMTP_HOST: mailpit + NOTIFICATIONS_SMTP_HOST: mailserver NOTIFICATIONS_SMTP_PORT: 1025 NOTIFICATIONS_SMTP_SENDER: oCIS notifications NOTIFICATIONS_SMTP_USERNAME: notifications@${OCIS_DOMAIN:-ocis.owncloud.test} NOTIFICATIONS_SMTP_INSECURE: "true" - mailpit: + mailserver: image: axllent/mailpit:v1.22.3 networks: - ocis-net @@ -16,11 +16,11 @@ services: - "1025:1025" # SMTP labels: - "traefik.enable=true" - - "traefik.http.routers.mailpit.entrypoints=https" - - "traefik.http.routers.mailpit.rule=Host(`${MAILPIT_DOMAIN:-mail.owncloud.test}`)" - - "traefik.http.routers.mailpit.tls.certresolver=http" - - "traefik.http.routers.mailpit.service=mailpit" - - "traefik.http.services.mailpit.loadbalancer.server.port=8025" + - "traefik.http.routers.mailserver.entrypoints=https" + - "traefik.http.routers.mailserver.rule=Host(`${MAIL_SERVER_DOMAIN:-mail.owncloud.test}`)" + - "traefik.http.routers.mailserver.tls.certresolver=http" + - "traefik.http.routers.mailserver.service=mailserver" + - "traefik.http.services.mailserver.loadbalancer.server.port=8025" logging: driver: ${LOG_DRIVER:-local} restart: always diff --git a/docs/ocis/deployment/continuous_deployment.md b/docs/ocis/deployment/continuous_deployment.md index b146f8947cf..aed254f462e 100644 --- a/docs/ocis/deployment/continuous_deployment.md +++ b/docs/ocis/deployment/continuous_deployment.md @@ -19,7 +19,7 @@ The configuration for the continuous deployment can be found in the [oCIS reposi # oCIS with Web Office -This deployment is based on our modular [ocis_full Example](ocis_full.md) and uses the default configuration with Collabora Online as the office suite, traefik reverse proxy, cloudimporter and the inbucket mail catching server to showcase the full feature set of oCIS. +This deployment is based on our modular [ocis_full Example](ocis_full.md) and uses the default configuration with Collabora Online as the office suite, traefik reverse proxy, cloudimporter and the mailpit mail catching server to showcase the full feature set of oCIS. Credentials: diff --git a/docs/ocis/deployment/ocis_full.md b/docs/ocis/deployment/ocis_full.md index 5ad2ed52858..4f0092721ba 100644 --- a/docs/ocis/deployment/ocis_full.md +++ b/docs/ocis/deployment/ocis_full.md @@ -178,7 +178,7 @@ See also [example server setup]({{< ref "preparing_server" >}}) # Define SMPT settings if you would like to send Infinite Scale email notifications. # For more details see: # https://doc.owncloud.com/ocis/latest/deployment/services/s-list/notifications.html - # NOTE: when configuring Inbucket, these settings have no effect, see inbucket.yml for details. + # NOTE: when configuring mail server, these settings have no effect, see mailserver.yml for details. # SMTP host to connect to. SMTP_HOST= # Port of the SMTP host to connect to. diff --git a/services/invitations/md-sources/example-realm.json b/services/invitations/md-sources/example-realm.json index 614d8005408..b72520c97cb 100644 --- a/services/invitations/md-sources/example-realm.json +++ b/services/invitations/md-sources/example-realm.json @@ -1420,8 +1420,8 @@ "replyToDisplayName": "", "starttls": "false", "auth": "", - "port": "2500", - "host": "inbucket", + "port": "1025", + "host": "mailserver", "replyTo": "", "from": "admin@owncloud.test", "fromDisplayName": "AdminTest",