Todo For Next Update
Todo For Next Update
When you introduce a new version and branding and deploy it on your network, you need to consider the following changes and actions:
Network policy: registration & feature flags moved to runtime config
The following flags are now part of the runtime network policy (bucket B): they are served by the backend at runtime, can be changed live by an admin under Admin → Network policy (no redeploy), and are seeded from the backend ENV on first start. They are no longer read from the webapp build/ENV.
ASK_FOR_REAL_NAME,REQUIRE_LOCATION,BADGES_ENABLED,INVITE_LINK_LIMIT— these used to be webapp ENV variables. Action: move them to the backend environment (.env,docker-compose.ymlorvalues.yaml). If you previously set e.g.BADGES_ENABLED=trueon the webapp only, set it on the backend now (or toggle it in the admin UI), otherwise it falls back to the schema default.MAX_GROUP_PINNED_POSTS,API_KEYS_MAX_PER_USER,MAX_PINNED_POSTS,INVITE_CODES_PERSONAL_PER_USER,INVITE_CODES_GROUP_PER_USER— already backend ENV variables; no change to where you set them. They are now additionally editable live in the admin UI; the backend ENV value is the seed/resetdefault.
Remove BADGES_ENABLED, ASK_FOR_REAL_NAME, REQUIRE_LOCATION, INVITE_LINK_LIMIT, MAX_GROUP_PINNED_POSTS and API_KEYS_MAX_PER_USER from the webapp environment — the webapp no longer reads them (see webapp/.env.template).
Layout toggles moved from branding constants to the network policy
SHOW_CONTENT_FILTER_HEADER_MENU, SHOW_CONTENT_FILTER_MASONRY_GRID and SHOW_GROUP_BUTTON_IN_HEADER were webapp branding constants (branding/constants/filter.{js,ts} and groups.{js,ts}). They are now runtime network-policy keys (showContentFilterHeaderMenu, showContentFilterMasonryGrid, showGroupButtonInHeader), live-editable under Admin → Network policy → Layout. Action: set them via the backend ENV (SHOW_CONTENT_FILTER_HEADER_MENU etc., defaults true/false/true) or in the admin UI, and drop them from your branding/constants/filter and groups — the webapp no longer reads them there (webapp/constants/filter.js was removed; SHOW_GROUP_BUTTON_IN_HEADER removed from webapp/constants/groups.js).
Version >= 3.2.0 with 'ocelotDockerVersionTag' 3.2.0-XXX
Backend and Kubernetes Config DBMS_DEFAULT_DATABASE
- We have the new option to configure the default name of the Neo4j database to be used for operations and commands in environment variables (
.env,docker-compose.ymlorvalues.yaml). For more details see deployment-values.md:
DBMS_DEFAULT_DATABASE: "graph.db"The default value is neo4j if it is not set.
Webapp Config dateTime
- You can set
RELATIVE_DATETIMEandABSOLUT_DATETIME_FORMATinbranding/constants/dateTime.jsoriginally in main code filewebapp/constants/dateTime.jsto your preferred values.
Version >= 3.1.0 with 'ocelotDockerVersionTag' 3.1.0-555
- We have the new option to configure DKIM for sent e-mails in environment variables (
.env,docker-compose.ymlorvalues.yaml), see deployment-values.md:SMTP_DKIM_DOMAINNAME=SMTP_DKIM_KEYSELECTOR=SMTP_DKIM_PRIVATEKEY=
Version >= 2.7.0 with 'ocelotDockerVersionTag' 2.7.0-470
- You have to rename all
.jsfiles to.tsinbranding/constants
Version >= 2.4.0 with 'ocelotDockerVersionTag' 2.4.0-298
- You have to set
SHOW_CONTENT_FILTER_HEADER_MENUandSHOW_CONTENT_FILTER_MASONRY_GRIDinbranding/constants/filter.jsoriginally in main code filewebapp/constants/filter.jsto your preferred values.
Main Code PR – feat(webapp): map #5843
- Create your own Mapbox account at https://mapbox.com/ for your organization to get your own Mapbox token.
- You have to add the
MAPBOX_TOKENfrom thedeployment/kubernetes/values.template.yamlto yourdeployment/kubernetes/values.yamland set it to your own Mapbox token.
Version >= 2.2.0 with 'ocelotDockerVersionTag' 2.2.0-267
Main Code PR – feat: 🍰 Footer And Header Links Configurable To Have External Link Target #5590
- You have to add property
targetto all array elements with valueurlto your preferred value inbranding/constants/headerMenu.jsoriginally in main code filewebapp/constants/headerMenu.js. - You have to move value of all
externalLinkto new propertyexternalLink.urland set new propertyexternalLink.targetto your preferred value inbranding/constants/links.jsoriginally in main code filewebapp/constants/links.js.
Main Code PR – feat: 🍰 Make Donation Progress Bar Color Configurable #5593
- You have to set
PROGRESS_BAR_COLOR_TYPEinbranding/constants/donation.jsoriginally in main code filewebapp/constants/donation.jsto your preferred value.
Main Code PR – feat: 🍰 Header Logo Routing Update #5579
- You have to move value of
LOGO_HEADER_CLICK.externalLinkto new propertyLOGO_HEADER_CLICK.externalLink.urland set new propertyLOGO_HEADER_CLICK.externalLink.targetto your preferred value inbranding/constants/logos.jsoriginally in main code filewebapp/constants/logos.js.
Version >= 2.0.0 with 'ocelotDockerVersionTag' 2.0.0-250
Main Code PR – feat: 🍰 Implement LOGO_HEADER_CLICK As Configuration #5525
- You have to set
LOGO_HEADER_CLICKinbranding/constants/logos.jsoriginally in main code filewebapp/constants/logos.jsto your preferred value.
Main Code Issue – 🌟 [EPIC] Release v2.0.0 – Beta Test → Final #5547
- You have to set
SHOW_GROUP_BUTTON_IN_HEADERinbranding/constants/groups.jsoriginally in main code filewebapp/constants/groups.jsto your preferred value.
Version >= 1.1.0 with 'ocelotDockerVersionTag' 1.1.0-205
Deployment/Rebranding PR – chore: 🍰 Release v1.1.0 - Implement Categories Again #63
- You have to add the
CATEGORIES_ACTIVEfrom thedeployment/kubernetes/values.template.yamlto yourdeployment/kubernetes/values.yamland set it to your preferred value. - Make sure the correct categories are in your Neo4j database on the server.
Version >= 1.0.9 with 'ocelotDockerVersionTag' 1.0.9-199
Deployment/Rebranding PR – chore: 🍰 Implement PRODUCTION_DB_CLEAN_ALLOW for Staging Production Environments #56
- Copy
PRODUCTION_DB_CLEAN_ALLOWfromdeployment/kubernetes/values.template.yamltovalues.yamland set it tofalsefor production environments and only for several stage test servers totrue.
Deployment/Rebranding PR – chore: [WIP] 🍰 Refine docs, first step #46
Upgrade the cert-manager, but install CRDs of the version 1.0.0-alpha to actually be able to upgrade ocelot. Then uninstall the legacy CRDs and install the correct ones.
# upgrade cert-manager to 1.9.1
> helm upgrade --set installCRDs=true --version 1.9.1 --namespace cert-manager cert-manager jetstack/cert-manager
# apply legacy CRDs
> kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.0.0-alpha.1/cert-manager.crds.yaml
# upgrade ocelot
> helm upgrade ocelot ./
# delete legacy CRDs
> kubectl delete -f https://github.com/cert-manager/cert-manager/releases/download/v1.0.0-alpha.1/cert-manager.crds.yaml
# apply CRDs for cert-manager 1.9.1
> kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.9.1/cert-manager.crds.yamlBackground: We had to upgrade cert-manager due to an external dependency - therefore we had to update cert-manager apiVersion cert-manager.io/v1alpha2 to cert-manager.io/v1.
The error occurring when not doing this is the following:
Error: UPGRADE FAILED: unable to build kubernetes objects from current release manifest: [resource mapping not found for name: "letsencrypt-production" namespace: "" from "": no matches for kind "ClusterIssuer" in version "cert-manager.io/v1alpha2"
ensure CRDs are installed first, resource mapping not found for name: "letsencrypt-staging" namespace: "" from "": no matches for kind "ClusterIssuer" in version "cert-manager.io/v1alpha2"
ensure CRDs are installed first]Version >= 1.0.8 with 'ocelotDockerVersionTag' 1.0.8-182
PR – feat: 🍰 Configure Cookie Expire Time #43
- You have to add the
COOKIE_EXPIRE_TIMEfrom thedeployment/kubernetes/values.template.yamlto yourdeployment/kubernetes/values.yamland set it to your preferred value. - Correct
localecookie exploration time in data privacy.
Version 1.0.7 with 'ocelotDockerVersionTag' 1.0.7-171
- No information.