#1402 Environment variables for custom image (#1403)

* chore: enhance compose.yaml with variables for customize

* chore: use default blank values for db and redis variables in compose.yaml

* chore: Use env var for HTTP(S) publish ports in overrides

* docs: explain use of environment variables for image customization

* chore: use ERPNEXT_VERSION as default

* docs: fixed spelling errors

CODE_OF_CONDUCT.md

@@ -6,7 +6,7 @@ In the interest of fostering an open and welcoming environment, we as
 contributors and maintainers pledge to making participation in our project and
 our community a harassment-free experience for everyone, regardless of age, body
 size, disability, ethnicity, sex characteristics, gender identity and expression,
-level of experience, education, socio-economic status, nationality, personal
+level of experience, education, socioeconomic status, nationality, personal
 appearance, race, religion, or sexual identity and orientation.
 
 ## Our Standards

compose.yaml

@@ -2,7 +2,8 @@ x-customizable-image: &customizable_image
   # By default the image used only contains the `frappe` and `erpnext` apps.
   # See https://github.com/frappe/frappe_docker/blob/main/docs/custom-apps.md
   # about using custom images.
-  image: frappe/erpnext:${ERPNEXT_VERSION:?No ERPNext version set}
+  image: ${CUSTOM_IMAGE:-frappe/erpnext}:${CUSTOM_TAG:-${ERPNEXT_VERSION:?No ERPNext version or tag set}}
+  pull_policy: ${PULL_POLICY:-always}
 
 x-depends-on-configurator: &depends_on_configurator
   depends_on:
@@ -32,10 +33,10 @@ services:
         bench set-config -g redis_socketio "redis://$$REDIS_QUEUE";
         bench set-config -gp socketio_port $$SOCKETIO_PORT;
     environment:
-      DB_HOST: ${DB_HOST}
-      DB_PORT: ${DB_PORT}
-      REDIS_CACHE: ${REDIS_CACHE}
-      REDIS_QUEUE: ${REDIS_QUEUE}
+      DB_HOST: ${DB_HOST:-}
+      DB_PORT: ${DB_PORT:-}
+      REDIS_CACHE: ${REDIS_CACHE:-}
+      REDIS_QUEUE: ${REDIS_QUEUE:-}
       SOCKETIO_PORT: 9000
     depends_on: {}
 

docs/custom-apps.md

@@ -104,14 +104,34 @@ More about [kaniko](https://github.com/GoogleContainerTools/kaniko)
 
 ### Use Images
 
-On the [compose.yaml](../compose.yaml) replace the image reference to the `tag` you used when you built it. Then, if you used a tag like `custom_erpnext:staging` the `x-customizable-image` section will look like this:
+In the [compose.yaml](../compose.yaml), you can set the image name and tag through environment variables, making it easier to customize.
 
-```
+```yaml
 x-customizable-image: &customizable_image
-  image: custom_erpnext:staging
-  pull_policy: never
+  image: ${CUSTOM_IMAGE:-frappe/erpnext}:${CUSTOM_TAG:-${ERPNEXT_VERSION:?No ERPNext version or tag set}}
+  pull_policy: ${PULL_POLICY:-always}
 ```
 
-The `pull_policy` above is optional and prevents `docker` to try to download the image when that one has been built locally.
+The environment variables can be set in the shell or in the .env file as [setup-options.md](setup-options.md) describes.
+
+- `CUSTOM_IMAGE`: The name of your custom image. Defaults to `frappe/erpnext` if not set.
+- `CUSTOM_TAG`: The tag for your custom image. Must be set if `CUSTOM_IMAGE` is used. Defaults to the value of `ERPNEXT_VERSION` if not set.
+- `PULL_POLICY`: The Docker pull policy. Defaults to `always`. Recommended set to `never` for local images, so prevent `docker` from trying to download the image when it has been built locally.
+- `HTTP_PUBLISH_PORT`: The port to publish through no SSL channel. Default depending on deployment, it may be `80` if SSL activated or `8080` if not.
+- `HTTPS_PUBLISH_PORT`: The secure port to publish using SSL. Default is `443`.
 
 Make sure image name is correct to be pushed to registry. After the images are pushed, you can pull them to servers to be deployed. If the registry is private, additional auth is needed.
+
+#### Example
+
+If you built an image with the tag `ghcr.io/user/repo/custom:1.0.0`, you would set the environment variables as follows:
+
+```bash
+export CUSTOM_IMAGE='ghcr.io/user/repo/custom'
+export CUSTOM_TAG='1.0.0'
+docker compose -f compose.yaml \
+  -f overrides/compose.mariadb.yaml \
+  -f overrides/compose.redis.yaml \
+  -f overrides/compose.https.yaml \
+  config > ~/gitops/docker-compose.yaml
+```

overrides/compose.https.yaml

@@ -21,8 +21,8 @@ services:
       - --certificatesResolvers.main-resolver.acme.email=${LETSENCRYPT_EMAIL:?No Let's Encrypt email set}
       - --certificatesResolvers.main-resolver.acme.storage=/letsencrypt/acme.json
     ports:
-      - 80:80
-      - 443:443
+      - ${HTTP_PUBLISH_PORT:-80}:80
+      - ${HTTPS_PUBLISH_PORT:-443}:443
     volumes:
       - cert-data:/letsencrypt
       - /var/run/docker.sock:/var/run/docker.sock:ro

overrides/compose.noproxy.yaml

@@ -1,4 +1,4 @@
 services:
   frontend:
     ports:
-      - 8080:8080
+      - ${HTTP_PUBLISH_PORT:-8080}:8080

overrides/compose.proxy.yaml

@@ -13,7 +13,7 @@ services:
       - --providers.docker.exposedbydefault=false
       - --entrypoints.web.address=:80
     ports:
-      - 80:80
+      - ${HTTP_PUBLISH_PORT:-80}:80
     volumes:
       - /var/run/docker.sock:/var/run/docker.sock:ro
     userns_mode: host

overrides/compose.traefik-ssl.yaml

@@ -40,7 +40,7 @@ services:
       # Enable the Dashboard and API
       - --api
     ports:
-      - 443:443
+      - ${HTTPS_PUBLISH_PORT:-443}:443
     volumes:
       - cert-data:/certificates
 

overrides/compose.traefik.yaml

@@ -35,7 +35,7 @@ services:
       # Enable the Dashboard and API
       - --api
     ports:
-      - 80:80
+      - ${HTTP_PUBLISH_PORT:-80}:80
     volumes:
       - /var/run/docker.sock:/var/run/docker.sock:ro
     networks: