@escolalms/cla - npm Package Compare versions

Comparing version 1.2.11 to 1.2.12

package.json

 {
   "name": "@escolalms/cla",
-  "version": "1.2.11",
+  "version": "1.2.12",
   "description": "Create LMS APP. Escola LMS. Wellms. ",
   "main": "index.js",
   "scripts": {
-    "init": "git clone https://github.com/EscolaLMS/Create-LMS-App.git EscolaLMS && cd EscolaLMS && rm -rf .git && ./init.sh"
+    "init": "git clone https://github.com/EscolaLMS/Create-LMS-App.git EscolaLMS && cd EscolaLMS && rm -rf .git && ./init.sh",
+    "k8s-init": "git clone https://github.com/EscolaLMS/Create-LMS-App.git EscolaLMS && cd EscolaLMS && rm -rf .git && ./init.sh"
   },
@@ -23,5 +24,7 @@ "repository": {
   "bin": {
-    "lms": "pull_init.sh"
+    "lms": "pull_init.sh",
+    "k8s-init": "pull_init_k8s.sh",
+    "k8s-yamls": "pull_init_k8s_generate.sh"
   },
   "homepage": "https://github.com/EscolaLMS/Create-LMS-App#readme"
 }

readme.md

 # Create LMS APP
 
-Development version
+This package contains all the resources need to install Wellms Headless LMS from docker-images
 
 ## Installation on MacOs or Linux
 
+Below are instruction on how to install Wellms on MacOs or Linux.
+Windows with WSL should work fine, yet there might be some issues
+
+- please [do share them](https://github.com/EscolaLMS/Create-LMS-App/issues/new) with us.
+
+## Environmental variables
+
+### Laravel specific. `LARAVEL_PREFIX`
+
+After container is initialized, it [looks for variables](https://github.com/EscolaLMS/API/blob/develop/docker/envs/envs.php) with this prefix then replace current ones in `.env` file
+
+Example
+
+```yaml
+LARAVEL_APP_ENV: "production"
+LARAVEL_APP_KEY: "base64:vw6G2uP8LV22haEERtzr5yDCBraLrMwbxlbSJDA97uk="
+LARAVEL_APP_DEBUG: "false"
+LARAVEL_APP_LOG: "errorlog"
+```
+
+will result in
+
+```bash
+Replacing .env file APP_ENV from local to production
+Replacing .env file APP_KEY from base64:pveos6JL8iCwO3MbzoyQpNx6TETMYuUpfZ18CDKl6Cw= to base64:vw6G2uP8LV22haEERtzr5yDCBraLrMwbxlbSJDA97uk=
+Replacing .env file APP_DEBUG from true to false
+Replacing .env file APP_LOG_LEVEL from debug to debug
+```
+
+### URLs
+
+You can use this following variables when calling bash or makefile task
+
+```bash
+APP_URL="${APP_URL:-http://api.wellms.localhost}"
+ADMIN_URL="${ADMIN_URL:-http://admin.wellms.localhost}"
+FRONT_URL="${FRONT_URL:-http://app.wellms.localhost}"
+MAILHOG_URL="${MAILHOG_URL:-http://mailhog.wellms.localhost}"
+```
+
+Example
+
+```bash
+APP_URL=http://my-super-api.localhost make init
+```
+
+or
+
+```bash
+APP_URL=http://my-super-api.localhost make k8s-rebuild
+```
+
+## Kubernetes
+
+### Without `helm`
+
+All `yaml` file templates are inside [`k8s/tpls`](k8s/tpls) folder
+
+You can either generate yaml by calling bash script `cd k8s && bash generate.sh`
+or by calling makefile job `make
+or but setting all config manually
+
+Once `yaml` files are in `k8s` folder run `kubectl apply -f k8s`
+
+#### Custom domain
+
+Those are env variables you can set while running generate
+
+```bash
+APP_URL="${APP_URL:-http://api.wellms.localhost}"
+ADMIN_URL="${ADMIN_URL:-http://admin.wellms.localhost}"
+FRONT_URL="${FRONT_URL:-http://app.wellms.localhost}"
+MAILHOG_URL="${MAILHOG_URL:-http://mailhog.wellms.localhost}"
+```
+
+#### Makefile jobs
+
+### With `helm`
+
+`WIP`
+
+## From docker container images
+
+Below are instructions how to install Wellms from [https://hub.docker.com/search?q=escolalms](docker images) in various ways.
+
 ### Requirements
@@ -32,6 +117,8 @@
 
-*Recommended*: use Windows Terminal (https://apps.microsoft.com/store/detail/windows-terminal/) and latest PowerShell (https://docs.microsoft.com/en-us/powershell/scripting/install/installing-powershell-on-windows?view=powershell-7.2)
+_Recommended_: use Windows Terminal (https://apps.microsoft.com/store/detail/windows-terminal/) and latest PowerShell (https://docs.microsoft.com/en-us/powershell/scripting/install/installing-powershell-on-windows?view=powershell-7.2)
 
 ### Installation from source
 
+The `source` means source code of this repository, not the actual Wellms components. Tasks describes below will install docker containers.
+
 - Clone this repository
@@ -71,4 +158,2 @@ - Run `make init` in PowerShell (and not in WSL shell, because it will lead to problems with binding Postgres data volume for persistence)
 ```yml
-# NOTE binding emptyfile.conf disable supervisor service
-
 api:
@@ -79,7 +164,9 @@ image: escolalms/api:latest
   volumes:
-    - ./emptyfile.conf:/etc/supervisor/custom.d/horizon.conf
-    - ./emptyfile.conf:/etc/supervisor/custom.d/scheduler.conf
-    #      - ./emptyfile.conf:/etc/supervisor/custom.d/nginx.conf
     - ./storage:/var/www/html/storage
     - ./.env:/var/www/html/.env
+  environment:
+    - DISBALE_PHP_FPM=false
+    - DISBALE_NGINX=false
+    - DISBALE_HORIZON=true
+    - DISBALE_SCHEDULER=true
 
@@ -91,7 +178,9 @@ horizon:
   volumes:
-    #     - ./emptyfile.conf:/etc/supervisor/custom.d/horizon.conf
-    - ./emptyfile.conf:/etc/supervisor/custom.d/scheduler.conf
-    - ./emptyfile.conf:/etc/supervisor/custom.d/nginx.conf
     - ./storage:/var/www/html/storage
     - ./.env:/var/www/html/.env
+  environment:
+    - DISBALE_PHP_FPM=true
+    - DISBALE_NGINX=true
+    - DISBALE_HORIZON=false
+    - DISBALE_SCHEDULER=true
 
@@ -103,7 +192,9 @@ scheduler:
   volumes:
-    - ./emptyfile.conf:/etc/supervisor/custom.d/horizon.conf
-    #      - ./emptyfile.conf:/etc/supervisor/custom.d/scheduler.conf
-    - ./emptyfile.conf:/etc/supervisor/custom.d/nginx.conf
     - ./storage:/var/www/html/storage
     - ./.env:/var/www/html/.env
+  environment:
+    - DISBALE_PHP_FPM=true
+    - DISBALE_NGINX=true
+    - DISBALE_HORIZON=true
+    - DISBALE_SCHEDULER=false
 ```

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

33771

increased by111.35%

Number of package files

34

increased by88.89%

Number of lines in readme file

196

increased by86.67%

No dependency changes