christianlight
/
tutor
mirror of https://github.com/ChristianLight/tutor.git
7
0
Fork 0
Code Issues Releases Activity
tutor/tutor/templates/config/defaults.yml

80 lines
2.6 KiB
YAML
Raw Normal View History

Tutor v3 complete rewrite Replace all make commands by a single "tutor" binary. Environment and data are all moved to ~/.tutor/local/share/tutor. We take the opportunity to add a web UI and revamp the documentation. This is a complete rewrite. Close #121. Close #147.
2019-01-22 20:25:04 +00:00
---
refactor: clarify configuration management Previously, configuration management was very confusing because we kept mixing "base" and "defaults" configuration: - It was difficult to make the difference between core settings that were necessary (e.g: passwords) as opposed to others that could simply be defaulted to. - The order of settings in config.yml mattered: config entries that depended on other needed to be defined later. As a consequence, Tutor was not compatible with Python 3.5, where dict entries are not sorted.
2021-11-08 13:46:38 +00:00
# This file includes all Tutor setting defaults. Settings that do not have a
# default value, such as passwords, should be stored in base.yml.
Fix missing password values from generated configuration Passwords were not being stored to config.yml during the first quickstart.
2019-06-24 10:36:19 +00:00
# This must be defined early
feat: get rid of the nginx container and services Nginx and Caddy performed duplicate tasks. It was decided to get rid of the nginx container, for simplification. This is a breaking change for plugin developers. Also, applications that collect nginx logs will have to be modified. See: - Corresponding TEP: https://discuss.overhang.io/t/tep-get-rid-of-the-nginx-container/2024 - the prior discussion: https://discuss.overhang.io/t/why-caddy-nginx/1952
2021-10-14 10:47:23 +00:00
CADDY_HTTP_PORT: 80
Fix missing password values from generated configuration Passwords were not being stored to config.yml during the first quickstart.
2019-06-24 10:36:19 +00:00
CMS_HOST: "studio.{{ LMS_HOST }}"
feat: upgrade to Maple - A shared cookie domain between lms and cms is no longer recommended: https://github.com/edx/edx-platform/blob/master/docs/guides/studio_oauth.rst - refactor: clean mounted data folder in lms/cms. In Lilac, the bind-mounted lms/data and cms/data folders are a mess because new folders are created there for every new course organisation. These folders are empty. As far as we know they are useless... With this change we move these folders to a dedicated "modulestore" subdirectory; which corresponds better to the initial intent of the fs_root setting. - fix: frontend failure during login to the lms. See: https://github.com/openedx/build-test-release-wg/issues/104 - feat: move all forum-related code to a dedicated plugin. Forum is an optional feature, and as such it deserves its own plugin. Starting from Maple, users will be able to install the forum from https://github.com/overhangio/tutor-forum/ - migrate from DCS_* session cookie settings to SESSION_*. That's because edx-platform no longer depends on django-cookies-samesite. Close https://github.com/openedx/build-test-release-wg/issues/110 - get rid of tons of deprecation warnings in the lms/cms - feat: make it possible to point to themed assets. Cherry-picking this change makes it possible to point to themed assets with a theme-agnostic url, notably from MFEs. - Install all official plugins as part of the `tutor[full]` package. - Don't print error messages about loading plugins during autocompletion. - Prompt for image building when upgrading from one release to the next. - Add `tutor local start --skip-build` option to skip building Docker images. Close #450. Close #545.
2021-10-18 09:43:40 +00:00
CMS_OAUTH2_KEY_SSO: "cms-sso"
CMS_OAUTH2_KEY_SSO_DEV: "cms-sso-dev"
Fix missing password values from generated configuration Passwords were not being stored to config.yml during the first quickstart.
2019-06-24 10:36:19 +00:00
CONTACT_EMAIL: "contact@{{ LMS_HOST }}"
fix: docker-compose project name in dev on nightly Project name was incorrectly set to "tutor_dev" instead of "tutor_nightly_dev".
2021-11-29 13:12:22 +00:00
DEV_PROJECT_NAME: "{{ TUTOR_APP }}_dev"
feat: add --mount option to local/dev The `--mount` option is available both with `tutor local` and `tutor dev` commands. It allows users to easily bind-mount containers from the host to containers. Yes, I know, we already provide that possibility with the `bindmount` command and the `--volume=/path/` option. But these suffer from the following drawbacks: - They are difficult to understand. - The "bindmount" command name does not make much sense. - It's not convenient to mount an arbitrary folder from the host to multiple containers, such as the many lms/cms containers (web apps, celery workers and job runners). To address this situation, we now recommend to make use of --mount: 1. `--mount=service1[,service2,...]:/host/path:/container/path`: manually mount `/host/path` to `/container/path` in container "service1" (and "service2"). 2. `--mount=/host/path`: use the new v1 plugin API to discover plugins that will detect this option and select the right containers in which to bind-mount volumes. This is really nifty... Close https://github.com/overhangio/2u-tutor-adoption/issues/43
2022-04-15 08:51:19 +00:00
DOCKER_COMPOSE_VERSION: "3.7"
Tutor docker images should point to docker.io, too
2020-01-10 16:22:01 +00:00
DOCKER_REGISTRY: "docker.io/"
Make it possible to override the docker registry for individual services Previously, it was not possible to override the docker registry for just one or a few services. Setting the DOCKER_REGISTRY configuration parameter would apply to all images. This was inconvenient. To resolve this, we include the docker registry value in the DOCKER_IMAGE_* configuration parameters. This allows users to override the docker registry individually by defining the DOCKER_IMAGE_SERVICENAME configuration parameter. See https://discuss.overhang.io/t/kubernetes-ci-cd-pipeline/765/3
2020-07-21 07:13:00 +00:00
DOCKER_IMAGE_OPENEDX: "{{ DOCKER_REGISTRY }}overhangio/openedx:{{ TUTOR_VERSION }}"
fix: pin openedx dev Docker image tag with tutor version When running: tutor dev run -m /path/to/edx-platform lms pip install -r requirements/edx/development.txt I realised that I was re-installing packages that should already have been present in the image. The reason for that was that I was running an outdated version of the dev version of the openedx Docker image. This happens because `tutor dev run` does not trigger an image re-build. We solve this issue by pinning the openedx dev Docker image tag to the current tutor version.
2022-11-28 10:16:28 +00:00
DOCKER_IMAGE_OPENEDX_DEV: "openedx-dev:{{ TUTOR_VERSION }}"
feat: overridable lms/cms max upload size Users want to be able to override the request `max_size` to upload larger files. But they will not be able to if the patch is placed after the `request` directive. So we move the patch statement before the directive. Also, we wrap the `request_body` directives within `handle` statements. If not, then different sizes are not managed properly. To override the max upload size in the cms, add the following to the "caddyfile-cms" patch: handle_path /import/* { request_body { max_size 500MB } } See discussion: https://discuss.openedx.org/t/how-to-update-caddyfile-using-tutor-plugin/8944
2023-01-30 10:31:38 +00:00
DOCKER_IMAGE_CADDY: "docker.io/caddy:2.6.2"
feat: upgrade to Maple - A shared cookie domain between lms and cms is no longer recommended: https://github.com/edx/edx-platform/blob/master/docs/guides/studio_oauth.rst - refactor: clean mounted data folder in lms/cms. In Lilac, the bind-mounted lms/data and cms/data folders are a mess because new folders are created there for every new course organisation. These folders are empty. As far as we know they are useless... With this change we move these folders to a dedicated "modulestore" subdirectory; which corresponds better to the initial intent of the fs_root setting. - fix: frontend failure during login to the lms. See: https://github.com/openedx/build-test-release-wg/issues/104 - feat: move all forum-related code to a dedicated plugin. Forum is an optional feature, and as such it deserves its own plugin. Starting from Maple, users will be able to install the forum from https://github.com/overhangio/tutor-forum/ - migrate from DCS_* session cookie settings to SESSION_*. That's because edx-platform no longer depends on django-cookies-samesite. Close https://github.com/openedx/build-test-release-wg/issues/110 - get rid of tons of deprecation warnings in the lms/cms - feat: make it possible to point to themed assets. Cherry-picking this change makes it possible to point to themed assets with a theme-agnostic url, notably from MFEs. - Install all official plugins as part of the `tutor[full]` package. - Don't print error messages about loading plugins during autocompletion. - Prompt for image building when upgrading from one release to the next. - Add `tutor local start --skip-build` option to skip building Docker images. Close #450. Close #545.
2021-10-18 09:43:40 +00:00
DOCKER_IMAGE_ELASTICSEARCH: "docker.io/elasticsearch:7.10.1"
DOCKER_IMAGE_MONGODB: "docker.io/mongo:4.2.17"
DOCKER_IMAGE_MYSQL: "docker.io/mysql:5.7.35"
fix: permissions image name
2021-10-25 14:56:37 +00:00
DOCKER_IMAGE_PERMISSIONS: "{{ DOCKER_REGISTRY }}overhangio/openedx-permissions:{{ TUTOR_VERSION }}"
feat: upgrade to Maple - A shared cookie domain between lms and cms is no longer recommended: https://github.com/edx/edx-platform/blob/master/docs/guides/studio_oauth.rst - refactor: clean mounted data folder in lms/cms. In Lilac, the bind-mounted lms/data and cms/data folders are a mess because new folders are created there for every new course organisation. These folders are empty. As far as we know they are useless... With this change we move these folders to a dedicated "modulestore" subdirectory; which corresponds better to the initial intent of the fs_root setting. - fix: frontend failure during login to the lms. See: https://github.com/openedx/build-test-release-wg/issues/104 - feat: move all forum-related code to a dedicated plugin. Forum is an optional feature, and as such it deserves its own plugin. Starting from Maple, users will be able to install the forum from https://github.com/overhangio/tutor-forum/ - migrate from DCS_* session cookie settings to SESSION_*. That's because edx-platform no longer depends on django-cookies-samesite. Close https://github.com/openedx/build-test-release-wg/issues/110 - get rid of tons of deprecation warnings in the lms/cms - feat: make it possible to point to themed assets. Cherry-picking this change makes it possible to point to themed assets with a theme-agnostic url, notably from MFEs. - Install all official plugins as part of the `tutor[full]` package. - Don't print error messages about loading plugins during autocompletion. - Prompt for image building when upgrading from one release to the next. - Add `tutor local start --skip-build` option to skip building Docker images. Close #450. Close #545.
2021-10-18 09:43:40 +00:00
DOCKER_IMAGE_REDIS: "docker.io/redis:6.2.6"
fix: upgrade exim-relay SMTP image to make it work on arm64 Close #600.
2022-03-10 18:00:54 +00:00
DOCKER_IMAGE_SMTP: "docker.io/devture/exim-relay:4.95-r0-2"
feat: Make the platform repository and NPM registry configurable from config.yml Previously, the only way for Tutor users to use a fork of edx-platform or a custom NPM registry was to use build args during the image build. This is suboptimal in the case of automatically building images from CI pipelines, which may want to auto-detect when an image needs to be rebuilt based on config.yml changes. In addition, the EDX_PLATFORM_VERSION build argument can already be set via a corresponding config.yml parameter (OPENEDX_COMMON_VERSION), so it's reasonable to follow that precedent and also introduce config.yml parameters to correspond with the EDX_PLATFORM_REPOSITORY and NPM_REGISTRY build arguments. Thus, introduce two new configuration parameters: - EDX_PLATFORM_REPOSITORY - NPM_REGISTRY These parameters can now optionally be used instead of the aforementioned build args.
2022-03-25 08:04:26 +00:00
EDX_PLATFORM_REPOSITORY: "https://github.com/openedx/edx-platform.git"
fix: Correct EDX_PLATFORM_VERSION default for local edx-platform forks PR #619 set the EDX_PLATFORM_VERSION build arg's default to OPENEDX_COMMON_VERSION. While this works fine for setting a non-default branch to run edx code from (say, "master"), it may break if the user sets OPENEDX_COMMON_VERSION to a branch or tag name that does not exist upstream in repositories *other than* EDX_PLATFORM_REPOSITORY. Thus, introduce a separate configuration parameter, EDX_PLATFORM_VERSION, to match the build arg of the same name. Set its default to OPENEDX_COMMON_VERSION. This way, the user can deploy an arbitrarily-named fork of edx-platform, while retaining the default OPENEDX_COMMON_VERSION (like, for example "open-release/maple.3") for everything else.
2022-04-13 09:15:35 +00:00
EDX_PLATFORM_VERSION: "{{ OPENEDX_COMMON_VERSION }}"
Make it possible to configure data services host/port In the future, we want to allow users to rely on third-party services for data storage, such as hosted MySQL and such. To do so, we need to be able to configure the host/port of these services, which we do here. This is to address part of #114.
2019-03-20 17:57:10 +00:00
ELASTICSEARCH_HOST: "elasticsearch"
ELASTICSEARCH_PORT: 9200
Rename *_PROTOCOL to *_SCHEME
2020-03-12 08:37:22 +00:00
ELASTICSEARCH_SCHEME: "http"
Fix broken elasticsearch configuration Because we are running a version of elasticsearch older than Methusalem, the docker environment variables were not properly taken into account. For instance, the cluster name and "mlockall" settings were incorrect, as we could see by running: $ tutor local run lms curl elasticsearch:9200 | grep cluster_name ... "cluster_name" : "elasticsearch", $ tutor local run lms curl elasticsearch:9200/_nodes/process?pretty | grep mlock ... "mlockall" : false See https://discuss.overhang.io/t/elastic-container-is-not-being-removed/312/3 for discussion. This fix also introduces a new tutor configuration setting to adjust the elasticsearch heap size.
2020-02-26 10:47:43 +00:00
ELASTICSEARCH_HEAP_SIZE: 1g
feat: get rid of the nginx container and services Nginx and Caddy performed duplicate tasks. It was decided to get rid of the nginx container, for simplification. This is a breaking change for plugin developers. Also, applications that collect nginx logs will have to be modified. See: - Corresponding TEP: https://discuss.overhang.io/t/tep-get-rid-of-the-nginx-container/2024 - the prior discussion: https://discuss.overhang.io/t/why-caddy-nginx/1952
2021-10-14 10:47:23 +00:00
ENABLE_HTTPS: false
ENABLE_WEB_PROXY: true
More explicit JWT configuration values
2019-07-08 06:00:20 +00:00
JWT_COMMON_AUDIENCE: "openedx"
v11.0.0 (2020-12-09) - 💥[Improvement] Upgrade Open edX to Koa - 💥 Setting changes: - The ``ACTIVATE_HTTPS`` setting was renamed to ``ENABLE_HTTPS``. - Other ``ACTIVATE_*`` variables were all renamed to ``RUN_*``. - The ``WEB_PROXY`` setting was removed and ``RUN_CADDY`` was added. - The ``NGINX_HTTPS_PORT`` setting is deprecated. - Architectural changes: - Use Caddy as a web proxy for automated SSL/TLS certificate generation: - Nginx no longer listens to port 443 for https traffic - The Caddy configuration file comes with a new ``caddyfile`` patch for much simpler SSL/TLS management. - Configuration files for web proxies are no longer provided. - Kubernetes deployment no longer requires setting up a custom Ingress resource or custom manager. - Gunicorn and Whitenoise are replaced by uwsgi: this increases boostrap performance and makes it no longer necessary to mount media folders in the Nginx container. - Replace memcached and rabbitmq by redis. - Additional features: - Make it possible to disable all plugins at once with ``plugins disable all``. - Add ``tutor k8s wait`` command to wait for a pod to become ready - Faster, more reliable static assets with local memory caching - Deprecation: proxy files for Apache and Nginx are no longer provided out of the box. - Removed plugin `{{ patch (...) }}` statements: - "https-create", "k8s-ingress-rules", "k8s-ingress-tls-hosts": these are no longer necessary. Instead, declare your app in the "caddyfile" patch. - "local-docker-compose-nginx-volumes": this patch was primarily used to serve media assets. The recommended is now to serve assets with uwsgi.
2020-09-17 10:53:14 +00:00
JWT_COMMON_ISSUER: "{% if ENABLE_HTTPS %}https{% else %}http{% endif %}://{{ LMS_HOST }}/oauth2"
More explicit JWT configuration values
2019-07-08 06:00:20 +00:00
JWT_COMMON_SECRET_KEY: "{{ OPENEDX_SECRET_KEY }}"
Towards a stable Kubernetes integration Missing features: - https certificates - xqueue - lms/cms workers Moreover, we scalability issues due to the uploaded file storage in the lms/cms. To address this issue we need to develop the MinIO plugin so that it becomes compatible with Open edX. Close #126 #179 #187
2019-05-09 07:51:06 +00:00
K8S_NAMESPACE: "openedx"
Major refactoring of config module Configuration loading was overly complex. Here, we simplify it drastically with reasonable defaults. Hacky additional variables are unncessary now that we use custom jinja2 filters.
2019-05-11 22:11:44 +00:00
LANGUAGE_CODE: "en"
refactor: clarify configuration management Previously, configuration management was very confusing because we kept mixing "base" and "defaults" configuration: - It was difficult to make the difference between core settings that were necessary (e.g: passwords) as opposed to others that could simply be defaulted to. - The order of settings in config.yml mattered: config entries that depended on other needed to be defined later. As a consequence, Tutor was not compatible with Python 3.5, where dict entries are not sorted.
2021-11-08 13:46:38 +00:00
LMS_HOST: "www.myopenedx.com"
LOCAL_PROJECT_NAME: "{{ TUTOR_APP }}_local"
feat: support for mongodb SSL+auth source/mech+replica set This change builds upon a previously proposed PR: https://github.com/overhangio/tutor/pull/437 There was another long conversation about this topic here: https://github.com/overhangio/tutor-forum/pull/10#issuecomment-1314799915 We could have supported the MongoDB auth/replica set/ssl parameters as part of the MongoDB host URI, but then this URI is not supported in the forum plugin, which uses an old version of the mongoid client. We were hoping that the client would have been upgraded by now, but it's not been upgraded for a long time. The changes introduced here are 100% backward-compatible. The forum plugin will have to be updated to take into account the new parameters.
2021-05-20 00:30:28 +00:00
MONGODB_AUTH_MECHANISM: ""
MONGODB_AUTH_SOURCE: "admin"
Make it possible to configure data services host/port In the future, we want to allow users to rely on third-party services for data storage, such as hosted MySQL and such. To do so, we need to be able to configure the host/port of these services, which we do here. This is to address part of #114.
2019-03-20 17:57:10 +00:00
MONGODB_HOST: "mongodb"
MONGODB_DATABASE: "openedx"
Configurable mongodb username/password/port
2019-03-20 18:18:46 +00:00
MONGODB_PORT: 27017
MONGODB_USERNAME: ""
MONGODB_PASSWORD: ""
feat: support for mongodb SSL+auth source/mech+replica set This change builds upon a previously proposed PR: https://github.com/overhangio/tutor/pull/437 There was another long conversation about this topic here: https://github.com/overhangio/tutor-forum/pull/10#issuecomment-1314799915 We could have supported the MongoDB auth/replica set/ssl parameters as part of the MongoDB host URI, but then this URI is not supported in the forum plugin, which uses an old version of the mongoid client. We were hoping that the client would have been upgraded by now, but it's not been upgraded for a long time. The changes introduced here are 100% backward-compatible. The forum plugin will have to be updated to take into account the new parameters.
2021-05-20 00:30:28 +00:00
MONGODB_REPLICA_SET: ""
MONGODB_USE_SSL: false
refactor: clarify configuration management Previously, configuration management was very confusing because we kept mixing "base" and "defaults" configuration: - It was difficult to make the difference between core settings that were necessary (e.g: passwords) as opposed to others that could simply be defaulted to. - The order of settings in config.yml mattered: config entries that depended on other needed to be defined later. As a consequence, Tutor was not compatible with Python 3.5, where dict entries are not sorted.
2021-11-08 13:46:38 +00:00
OPENEDX_AWS_ACCESS_KEY: ""
OPENEDX_AWS_SECRET_ACCESS_KEY: ""
feat: upgrade to open-release/lilac.master One of the breaking changes of this release is the removal of the webui and android features; these are moved to dedicated plugins. This causes a breaking change: the renaming of the DOCKER_IMAGE_ANDROID config variable to ANDROID_DOCKER_IMAGE. See this TEP for reference: https://discuss.overhang.io/t/separate-webui-and-android-from-tutor-core-and-move-to-dedicated-plugins/1473
2021-04-13 20:14:43 +00:00
OPENEDX_CACHE_REDIS_DB: 1
OPENEDX_CELERY_REDIS_DB: 0
v11.0.0 (2020-12-09) - 💥[Improvement] Upgrade Open edX to Koa - 💥 Setting changes: - The ``ACTIVATE_HTTPS`` setting was renamed to ``ENABLE_HTTPS``. - Other ``ACTIVATE_*`` variables were all renamed to ``RUN_*``. - The ``WEB_PROXY`` setting was removed and ``RUN_CADDY`` was added. - The ``NGINX_HTTPS_PORT`` setting is deprecated. - Architectural changes: - Use Caddy as a web proxy for automated SSL/TLS certificate generation: - Nginx no longer listens to port 443 for https traffic - The Caddy configuration file comes with a new ``caddyfile`` patch for much simpler SSL/TLS management. - Configuration files for web proxies are no longer provided. - Kubernetes deployment no longer requires setting up a custom Ingress resource or custom manager. - Gunicorn and Whitenoise are replaced by uwsgi: this increases boostrap performance and makes it no longer necessary to mount media folders in the Nginx container. - Replace memcached and rabbitmq by redis. - Additional features: - Make it possible to disable all plugins at once with ``plugins disable all``. - Add ``tutor k8s wait`` command to wait for a pod to become ready - Faster, more reliable static assets with local memory caching - Deprecation: proxy files for Apache and Nginx are no longer provided out of the box. - Removed plugin `{{ patch (...) }}` statements: - "https-create", "k8s-ingress-rules", "k8s-ingress-tls-hosts": these are no longer necessary. Instead, declare your app in the "caddyfile" patch. - "local-docker-compose-nginx-volumes": this patch was primarily used to serve media assets. The recommended is now to serve assets with uwsgi.
2020-09-17 10:53:14 +00:00
OPENEDX_CMS_UWSGI_WORKERS: 2
OPENEDX_LMS_UWSGI_WORKERS: 2
Harmonize mysql usernames and passwords We were using the same password both for the root and the openedx user. This used to be fine, but alas it is so no longer.
2019-03-20 17:45:20 +00:00
OPENEDX_MYSQL_DATABASE: "openedx"
OPENEDX_MYSQL_USERNAME: "openedx"
feat: upgrade to olive
2022-11-22 12:53:29 +00:00
OPENEDX_COMMON_VERSION: "open-release/olive.1"
feat: allow to specify extra pip packages in config Added OPENEDX_EXTRA_PIP_REQUIREMENTS setting, which allows to specify extra pip packages that should be installed. Moved "openedx-scorm-xblock" package from Dockerfile to the new setting in the config.yml.
2021-11-17 18:37:35 +00:00
OPENEDX_EXTRA_PIP_REQUIREMENTS:
feat: upgrade to olive
2022-11-22 12:53:29 +00:00
- "openedx-scorm-xblock>=15.0.0,<16.0.0"
Make it possible to configure data services host/port In the future, we want to allow users to rely on third-party services for data storage, such as hosted MySQL and such. To do so, we need to be able to configure the host/port of these services, which we do here. This is to address part of #114.
2019-03-20 17:57:10 +00:00
MYSQL_HOST: "mysql"
MYSQL_PORT: 3306
Make the mysql root username a configuration parameter This allows users who connect to an external database to customise the root username. Indeed, quite often the "root" username is reserved. Close #328
2020-06-01 15:11:10 +00:00
MYSQL_ROOT_USERNAME: "root"
feat: Make the platform repository and NPM registry configurable from config.yml Previously, the only way for Tutor users to use a fork of edx-platform or a custom NPM registry was to use build args during the image build. This is suboptimal in the case of automatically building images from CI pipelines, which may want to auto-detect when an image needs to be rebuilt based on config.yml changes. In addition, the EDX_PLATFORM_VERSION build argument can already be set via a corresponding config.yml parameter (OPENEDX_COMMON_VERSION), so it's reasonable to follow that precedent and also introduce config.yml parameters to correspond with the EDX_PLATFORM_REPOSITORY and NPM_REGISTRY build arguments. Thus, introduce two new configuration parameters: - EDX_PLATFORM_REPOSITORY - NPM_REGISTRY These parameters can now optionally be used instead of the aforementioned build args.
2022-03-25 08:04:26 +00:00
NPM_REGISTRY: "https://registry.npmjs.org/"
Major refactoring of config module Configuration loading was overly complex. Here, we simplify it drastically with reasonable defaults. Hacky additional variables are unncessary now that we use custom jinja2 filters.
2019-05-11 22:11:44 +00:00
PLATFORM_NAME: "My Open edX"
chore: upgrade elasticsearch/mongodb/redis Open edX master now runs elasticsearch 7.10 and mongodb 4.2. Redis also received a minor upgrade.
2021-10-25 12:16:10 +00:00
PREVIEW_LMS_HOST: "preview.{{ LMS_HOST }}"
v11.0.0 (2020-12-09) - 💥[Improvement] Upgrade Open edX to Koa - 💥 Setting changes: - The ``ACTIVATE_HTTPS`` setting was renamed to ``ENABLE_HTTPS``. - Other ``ACTIVATE_*`` variables were all renamed to ``RUN_*``. - The ``WEB_PROXY`` setting was removed and ``RUN_CADDY`` was added. - The ``NGINX_HTTPS_PORT`` setting is deprecated. - Architectural changes: - Use Caddy as a web proxy for automated SSL/TLS certificate generation: - Nginx no longer listens to port 443 for https traffic - The Caddy configuration file comes with a new ``caddyfile`` patch for much simpler SSL/TLS management. - Configuration files for web proxies are no longer provided. - Kubernetes deployment no longer requires setting up a custom Ingress resource or custom manager. - Gunicorn and Whitenoise are replaced by uwsgi: this increases boostrap performance and makes it no longer necessary to mount media folders in the Nginx container. - Replace memcached and rabbitmq by redis. - Additional features: - Make it possible to disable all plugins at once with ``plugins disable all``. - Add ``tutor k8s wait`` command to wait for a pod to become ready - Faster, more reliable static assets with local memory caching - Deprecation: proxy files for Apache and Nginx are no longer provided out of the box. - Removed plugin `{{ patch (...) }}` statements: - "https-create", "k8s-ingress-rules", "k8s-ingress-tls-hosts": these are no longer necessary. Instead, declare your app in the "caddyfile" patch. - "local-docker-compose-nginx-volumes": this patch was primarily used to serve media assets. The recommended is now to serve assets with uwsgi.
2020-09-17 10:53:14 +00:00
REDIS_HOST: "redis"
REDIS_PORT: 6379
REDIS_USERNAME: ""
REDIS_PASSWORD: ""
refactor: clarify configuration management Previously, configuration management was very confusing because we kept mixing "base" and "defaults" configuration: - It was difficult to make the difference between core settings that were necessary (e.g: passwords) as opposed to others that could simply be defaulted to. - The order of settings in config.yml mattered: config entries that depended on other needed to be defined later. As a consequence, Tutor was not compatible with Python 3.5, where dict entries are not sorted.
2021-11-08 13:46:38 +00:00
RUN_CMS: true
RUN_ELASTICSEARCH: true
RUN_LMS: true
RUN_MONGODB: true
RUN_MYSQL: true
RUN_REDIS: true
RUN_SMTP: true
Pluggable SMTP service This is part of #114
2019-03-20 17:45:09 +00:00
SMTP_HOST: "smtp"
feat: run all services as unprivileged containers With this change, containers are no longer run as "root" but as unprivileged users. This is necessary in some environments, notably some Kubernetes clusters. To make this possible, we need to manually fix bind-mounted volumes in docker-compose. This is pretty much equivalent to the behaviour in Kubernetes, where permissions are fixed at runtime if the volume owner is incorrect. Thus, we have a consistent behaviour between docker-compose and Kubernetes. We achieve this by bind-mounting some repos inside "*-permissions" services. These services run as root user on docker-compose and will fix the required permissions, as per build/permissions/setowner.sh These services simply do not run on Kubernetes, where we don't rely on bind-mounted volumes. There, we make use of Kubernete's built-in volume ownership feature. With this change, we get rid of the "openedx-dev" Docker image, in the sense that it no longer has its own Dockerfile. Instead, the dev image is now simply a different target in the multi-layer openedx Docker image. This makes it much faster to build the openedx-dev image. Because we declare the APP_USER_ID in the dev/docker-compose.yml file, we need to pass the user ID from the host there. The only way to achieve that is with a tutor config variable. The downside of this approach is that the dev/docker-compose.yml file is no longer portable from one machine to the next. We consider that this is not such a big issue, as it affects the development environment only. We take this opportunity to replace the base image of the "forum" image. There is now no need to re-install ruby inside the image. The total image size is only decreased by 10%, but re-building the image is faster. In order to run the smtp service as non-root, we switch from namshi/smtp to devture/exim-relay. This change should be backward-compatible. Note that the nginx container remains privileged. We could switch to nginxinc/nginx-unprivileged, but it's probably not worth the effort, as we are considering to get rid of the nginx container altogether. Close #323.
2021-09-23 10:04:19 +00:00
SMTP_PORT: 8025
Configurable SMTP server authentication We can now define non-empty username/password for sending email.
2019-03-20 17:52:57 +00:00
SMTP_USERNAME: ""
SMTP_PASSWORD: ""
Add support for external SMTP server with TLS Note that this setting will not work with the default namshi smtp server shipped with tutor. Close #231.
2019-07-07 01:06:35 +00:00
SMTP_USE_TLS: false
Add support for SMTP SSL, in addition to TLS Note that SSL and TLS are incompatible. Close #231.
2019-07-07 22:24:35 +00:00
SMTP_USE_SSL: false