Template patch catalog
This is the list of all patches used across Tutor (outside of any plugin). Alternatively, you can search for patches in Tutor templates by grepping the source code:
git clone https://github.com/overhangio/tutor
cd tutor
git grep "{{ patch" -- tutor/templates
Or you can list all available patches with the following command:
tutor config patches list
See also this GitHub search.
caddyfile
File: apps/caddy/Caddyfile
Add here Caddy directives to redirect traffic from the outside to your service containers. You should make use of the “proxy” snippet that simplifies configuration and automatically configures logging. Also, make sure to use the $default_site_port
environment variable to make sure that your service will be accessible both when HTTPS is enabled or disabled. For instance:
{{ MYPLUGIN_HOST }}{$default_site_port} {
import proxy "myservice:8000"
}
See the Caddy reference documentation for more information.
caddyfile-cms
File: apps/caddy/Caddyfile
caddyfile-global
File: apps/caddy/Caddyfile
caddyfile-lms
File: apps/caddy/Caddyfile
caddyfile-proxy
File: apps/caddy/Caddyfile
cms-env
File: apps/openedx/config/cms.env.yml
cms-env-features
File: apps/openedx/config/cms.env.yml
common-env-features
Files: apps/openedx/config/cms.env.yml
, apps/openedx/config/lms.env.yml
dev-docker-compose-jobs-services
File: dev/docker-compose.jobs.yml
k8s-deployments
File: k8s/deployments.yml
k8s-jobs
File: k8s/jobs.yml
k8s-override
File: k8s/override.yml
Any Kubernetes resource definition in this patch will override the resource defined by Tutor, provided that their names match. See Customizing Kubernetes resources for an example.
k8s-services
File: k8s/services.yml
k8s-volumes
File: k8s/volumes.yml
kustomization
File: kustomization.yml
kustomization-commonlabels
File: kustomization.yml
kustomization-configmapgenerator
File: kustomization.yml
kustomization-patches-strategic-merge
File: kustomization.yml
This can be used to add more Kustomization patches that make use of the strategic merge mechanism.
kustomization-resources
File: kustomization.yml
lms-env
File: apps/openedx/config/lms.env.yml
lms-env-features
File: apps/openedx/config/lms.env.yml
local-docker-compose-caddy-aliases
File: local/docker-compose.prod.yml
local-docker-compose-cms-dependencies
File: local/docker-compose.yml
local-docker-compose-dev-services
File: dev/docker-compose.yml
local-docker-compose-jobs-services
File: local/docker-compose.jobs.yml
local-docker-compose-lms-dependencies
File: local/docker-compose.yml
local-docker-compose-permissions-command
File: apps/permissions/setowners.sh
Add commands to this script to set ownership of bind-mounted docker-compose volumes at runtime. See local-docker-compose-permissions-volumes
.
local-docker-compose-permissions-volumes
File: local/docker-compose.yml
Add bind-mounted volumes to this patch to set their owners properly. See local-docker-compose-permissions-command
.
local-docker-compose-prod-services
File: local/docker-compose.prod.yml
local-docker-compose-services
File: local/docker-compose.yml
openedx-auth
File: apps/openedx/config/partials/auth.yml
openedx-cms-common-settings
File: apps/openedx/settings/partials/common_cms.py
openedx-cms-development-settings
File: apps/openedx/settings/cms/development.py
openedx-cms-production-settings
File: apps/openedx/settings/cms/production.py
openedx-common-assets-settings
File: build/openedx/settings/partials/assets.py
openedx-common-i18n-settings
File: build/openedx/settings/partials/i18n.py
openedx-common-settings
File: apps/openedx/settings/partials/common_all.py
openedx-dev-dockerfile-post-python-requirements
File: build/openedx/Dockerfile
openedx-development-settings
Files: apps/openedx/settings/cms/development.py
, apps/openedx/settings/lms/development.py
openedx-dockerfile
File: build/openedx/Dockerfile
openedx-dockerfile-final
File: build/openedx/Dockerfile
openedx-dockerfile-git-patches-default
File: build/openedx/Dockerfile
openedx-dockerfile-minimal
File: build/openedx/Dockerfile
openedx-dockerfile-post-git-checkout
File: build/openedx/Dockerfile
openedx-dockerfile-post-python-requirements
File: build/openedx/Dockerfile
openedx-dockerfile-pre-assets
File: build/openedx/Dockerfile
openedx-lms-common-settings
File: apps/openedx/settings/partials/common_lms.py
Python-formatted LMS settings used both in production and development.
openedx-lms-development-settings
File: apps/openedx/settings/lms/development.py
Python-formatted LMS settings in development. Values defined here override the values from openedx-lms-common-settings
or openedx-lms-production-settings
.
openedx-lms-production-settings
File: apps/openedx/settings/lms/production.py
Python-formatted LMS settings in production. Values defined here override the values from openedx-lms-common-settings
.
redis-conf
File: apps/redis/redis.conf
Implement this patch to override hard-coded Redis configuration values. See the Redis configuration reference <https://redis.io/docs/management/config-file/>`__.
uwsgi-config
File: apps/openedx/settings/uwsgi.ini
A .INI formatted file used to extend or override the uWSGI configuration.
Check the uWSGI documentation for more details about the .INI format and the list of available options.