Security News
tea.xyz Spam Plagues npm and RubyGems Package Registries
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
@escolalms/cla
Advanced tools
Readme
This package contains all the resources need to install Wellms Headless LMS from docker-images
Run npx --package=@escolalms/cla lms
Below are instruction on how to install Wellms on MacOs or Linux. Windows with WSL should work fine, yet there might be some issues
LARAVEL_PREFIX
After container is initialized, it looks for variables with this prefix then replace current ones in .env
file
Example
LARAVEL_APP_ENV: "production"
LARAVEL_APP_KEY: "base64:vw6G2uP8LV22haEERtzr5yDCBraLrMwbxlbSJDA97uk="
LARAVEL_APP_DEBUG: "false"
LARAVEL_APP_LOG: "errorlog"
will result in
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
You can use this following variables when calling bash or makefile task
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
APP_URL=http://my-super-api.localhost make init
or
APP_URL=http://my-super-api.localhost make k8s-rebuild
helm
All yaml
file templates are inside 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
Those are env variables you can set while running generate
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}"
Required dependencies:
docker
k8s
minikube
k9s
or whatever to view your kubernetes resources (e.g. Lens
)Run makefile commands:
make minikube-init
make k8s-init
make minikube-tunnel
make minikube-force-delete
make k8s-rebuild
make minikube-tunnel
TODO
helm
WIP
api.wellms.localhost
app.wellms.localhost
admin.wellms.localhost
mailhog.wellms.localhost
Below are instructions how to install Wellms from [https://hub.docker.com/search?q=escolalms](docker images) in various ways.
docker
installedRun npx --package=@escolalms/cla lms
Clone this repository then,
in order to launch LMS
run make init
shell script
WSL
installed (https://docs.microsoft.com/en-us/windows/wsl/install)Docker
installed (https://docs.docker.com/desktop/windows/install/) and configured to use WSLmake
available in PowerShell (for example, you can install Chocolatey
https://chocolatey.org/install and then install make
using it)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)
The source
means source code of this repository, not the actual Wellms components. Tasks describes below will install docker containers.
make init
in PowerShell (and not in WSL shell, because it will lead to problems with binding Postgres data volume for persistence)Once everything is installed (takes a while)
there is a credentials.sh
script to generate config files, example
APP_URL=https://api.escolalms.com ADMIN_URL=https://admin.escolalms.com FRONT_URL=https://demo.escolalms.com ./credentials.sh MAILHOG_URL=https://mailhog.escolalms.com REPORTBRO_URL=https://reportbro.escolalms.com ./credentials.sh
By default all 3 threads phpfpm, Laravels Horizon and Scheduler are severed by one image container
php-fpm
serve main Laravel REST API (with nginx and caddy)horizon
is responsible for all queue servicesTask Scheduling
is responsible for all cron jobsAll of above including nginx are served by supervisor
, definition files are listed here
You can scale this by setting each process into separate image container, just by amending docker-compose.yml
in the following way
api:
image: escolalms/api:latest
networks:
- escola_lms
volumes:
- ./storage:/var/www/html/storage
- ./.env:/var/www/html/.env
environment:
- DISBALE_PHP_FPM=false
- DISBALE_NGINX=false
- DISBALE_HORIZON=true
- DISBALE_SCHEDULER=true
horizon:
image: escolalms/api:latest
networks:
- escola_lms
volumes:
- ./storage:/var/www/html/storage
- ./.env:/var/www/html/.env
environment:
- DISBALE_PHP_FPM=true
- DISBALE_NGINX=true
- DISBALE_HORIZON=false
- DISBALE_SCHEDULER=true
scheduler:
image: escolalms/api:latest
networks:
- escola_lms
volumes:
- ./storage:/var/www/html/storage
- ./.env:/var/www/html/.env
environment:
- DISBALE_PHP_FPM=true
- DISBALE_NGINX=true
- DISBALE_HORIZON=true
- DISBALE_SCHEDULER=false
FAQs
Create LMS APP. Escola LMS. Wellms.
The npm package @escolalms/cla receives a total of 0 weekly downloads. As such, @escolalms/cla popularity was classified as not popular.
We found that @escolalms/cla demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 5 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.