diff --git a/README.md b/README.md index 5f4f8bc0514998b0904789c281c6dd45ae9c8421..cc7aa268eb0e79363e724f0fa939fca4e63d4181 100644 --- a/README.md +++ b/README.md @@ -18,8 +18,8 @@ Currently, all systems are running in huaweicloud CCE engine as container, we ap ### Mail -Our mail list system is based on (Mailman + Exim4 + Postgres), thanks to maxking, our first version of system -is based on his [dockerfile](https://github.com/maxking/docker-mailman) on mailman suite. +Our mail list system is based on (Mailman + Exim4 + Postgres), thanks to [maxking](https://github.com/maxking/docker-mailman) +and [inifum](https://github.com/infinum/exim4-docker), our most of the docker files are built on their version. ### License diff --git a/THIRD PARTY OPEN SOURCE SOFTWARE NOTICE b/THIRD PARTY OPEN SOURCE SOFTWARE NOTICE new file mode 100644 index 0000000000000000000000000000000000000000..fa7c81fdee399887b6c2c047fcbc1cad7eeb41ef --- /dev/null +++ b/THIRD PARTY OPEN SOURCE SOFTWARE NOTICE @@ -0,0 +1,62 @@ + THIRD PARTY OPEN SOURCE SOFTWARE NOTICE + + +Please note we provide an open source software notice for the third party +open source software along with this software and/or this software component +contributed by openEuler (in the following just “this SOFTWARE”). The open +source software licenses are granted by the respective right holders. + +Warranty Disclaimer + + +THE OPEN SOURCE SOFTWARE IN THIS SOFTWARE IS DISTRIBUTED IN THE HOPE THAT IT +WILL BE USEFUL, BUT WITHOUT ANY WARRANTY, WITHOUT EVEN THE IMPLIED WARRANTY OF +MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. SEE THE APPLICABLE LICENSES +FOR MORE DETAILS. + +Copyright Notice and License Texts + + +Software: docker-mailman +Copyright notice: Copyright (c) 2017 Abhilash Raj +License: MIT License + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. + +Software: exim4-docker +Copyright notice: Copyright (c) 2017. Infinum +License: MIT License + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/mail/dockerfile/exim4/README.md b/mail/dockerfile/exim4/README.md deleted file mode 100644 index e796ff94a1c8472a3b05da1aa1992fcb42247896..0000000000000000000000000000000000000000 --- a/mail/dockerfile/exim4/README.md +++ /dev/null @@ -1,4 +0,0 @@ -# Exim4 Dockerfile -This dockerfile used to create the exim4 image used for mail list system, as a reminder all of -the related exim4 config files(25_mm3_macros/55_mm3_transport/455_mm3_router/etc) are been added via -a configmap when initialize the deployments, therefore it's not presence in dockerfile. \ No newline at end of file diff --git a/mail/k8s/README.md b/mail/k8s/README.md deleted file mode 100644 index c503f895d3147732af0f36d6ad12cff1a1e0e4c6..0000000000000000000000000000000000000000 --- a/mail/k8s/README.md +++ /dev/null @@ -1,24 +0,0 @@ -# Deploy mailman on kubernetes. - - -## Components -1. **Mailman Core**: Basically we use the image directly from [maxking](https://github.com/maxking/docker-mailman) and changed nothing. There is another copied version in dockerfile/core -2. **Mailman Web**: We built another version of mailman web image based from [maxking](https://github.com/maxking/docker-mailman), and the detail can be found in dockerfile/web/dockerfile.overwrite -3. **Postgres**: It's a standard image from `postgres:9.6-alpine`. -4. **Mailman Exim4**: This is an ubuntu 14.04 image with exim4 installed, see [exim4 guide](https://help.ubuntu.com/lts/serverguide/exim4.html) for more information. - - -## TODOS -1. mailman web https is not enabled, which is required for a production environment. -2. postgres database service should be upgraded into a Huaweicloud database service. -3. all of the domain name should be replaced with the production domain name, now it's `tommylike.me`. -4. EmptyDir volume is used for mailman-web service, this should be upgraded into a persistent volume. since all log file will be generated there. -5. `mailman-core` and `exim4` should be put into the same StatefulSet or use the identical persistent volume, since exim4 will try to recognize mailman receive lists which configured in mailman data folder. -6. Configmap should be upgraded to dynamic reading content from files. -7. static resource(/opt/mailman-web/static) for mailman web now is being served via uwsgi, we need move it into nginx's static folder for production use. -8. MAILMAN_ADMIN_USER & MAILMAN_ADMIN_EMAIL should be replaced, this is the initial admin user when cluster running up. -9. Admin page (/admin login with default Admin user) can be used to maintain the social accounts and this is used for social app login. -10. Mailman web and exim4 both are exposed via NodePort(check the related services) now, this should be upgraded to ClusterIP on huaweicloud. -11. Docker Images should be replaced. -12. Environment variables `HYPERKITTY_API_KEY` and `SECRET_KEY` should be upgraded. -13. `ALLOWED_HOSTS` should be upgraded to reflect the real hosts. \ No newline at end of file