https://github.com/escolalms/create-lms-app
Bash script to install WellmsLMS with oneliner
https://github.com/escolalms/create-lms-app
bash create-react-app installer
Last synced: about 1 year ago
JSON representation
Bash script to install WellmsLMS with oneliner
- Host: GitHub
- URL: https://github.com/escolalms/create-lms-app
- Owner: EscolaLMS
- Created: 2021-11-03T11:16:07.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-18T10:34:07.000Z (over 1 year ago)
- Last Synced: 2025-04-19T04:24:12.010Z (about 1 year ago)
- Topics: bash, create-react-app, installer
- Language: Smarty
- Homepage:
- Size: 96.7 KB
- Stars: 3
- Watchers: 3
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Create LMS APP
This package contains all the resources need to install Wellms Headless LMS from docker-images
## TL;DR
Run `npx --package=@escolalms/cla lms`
## 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}"
```
### First run
Required dependencies:
- `docker`
- `k8s`
- `minikube`
- `k9s` or whatever to view your kubernetes resources (e.g. `Lens`)
#### Mac OS
Run makefile commands:
- `make minikube-init`
- `make k8s-init`
- `make minikube-tunnel`
- wait a minute and enjoy the Wellms :)
### Rebuild existing instance
- `make minikube-force-delete`
- `make k8s-rebuild`
- `make minikube-tunnel`
#### Windows
`TODO`
### With `helm`
`WIP`
### Available Wellms resources:
- API `api.wellms.localhost`
- Front app `app.wellms.localhost`
- Admin panel `admin.wellms.localhost`
- Mailhog `mailhog.wellms.localhost`
## 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
- you have `docker` installed
- port 80 is free
### Installation from script
Run `npx --package=@escolalms/cla lms`
### Installation from source
Clone this repository then,
in order to launch LMS
run `make init` shell script
## Instalation on Windows
### Requirements
- `WSL` installed (https://docs.microsoft.com/en-us/windows/wsl/install)
- `Docker` installed (https://docs.docker.com/desktop/windows/install/) and configured to use WSL
- `make` 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)
### 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
- Run `make init` in PowerShell (and not in WSL shell, because it will lead to problems with binding Postgres data volume for persistence)
## First steps
Once everything is installed (takes a while)
- http://api.wellms.localhost/api/documentation API Swagger documentation
- http://admin.wellms.localhost admin panel credentials username: admin2@escolalms.com password: secret
- http://app.wellms.localhost demo panel credentials username: student@escolalms.com password: secret
- http://mailhog.wellms.localhost demo panel credentials username: student@escolalms.com password: secret
## Troubleshooting
- please create issue in this repository
- Windows users - this package is not tested on your system.
## Custom domains
- Amends [Caddyfile](Caddyfile) referring to the [official documentation](https://caddyserver.com/docs/caddyfile)
there is a `credentials.sh` script to generate config files, example
```bash
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
```
## Scaling php-fpm, Horizon & Scheduler.
By default all 3 threads phpfpm, Laravels Horizon and Scheduler are severed by one [image container](https://github.com/EscolaLMS/API/blob/develop/Dockerfile)
- `php-fpm` serve main Laravel REST API (with [nginx](https://github.com/EscolaLMS/API/tree/develop/docker/conf/nginx) and [caddy](https://github.com/EscolaLMS/Create-LMS-App/blob/main/Caddyfile))
- [`horizon`](https://laravel.com/docs/9.x/horizon) is responsible for all [queue services](https://laravel.com/docs/9.x/queues)
- [`Task Scheduling`](https://laravel.com/docs/9.x/scheduling) is responsible for all cron jobs
All of above including nginx are served by `supervisor`, definition files are [listed here](https://github.com/EscolaLMS/API/tree/develop/docker/conf/supervisor)
You can scale this by setting each process into separate image container, just by amending `docker-compose.yml` in the following way
```yml
api:
image: escolalms/api:latest
networks:
- escola_lms
volumes:
- ./storage:/var/www/html/storage
- ./.env:/var/www/html/.env
environment:
- DISABLE_PHP_FPM=false
- DISABLE_NGINX=false
- DISABLE_HORIZON=true
- DISABLE_SCHEDULER=true
horizon:
image: escolalms/api:latest
networks:
- escola_lms
volumes:
- ./storage:/var/www/html/storage
- ./.env:/var/www/html/.env
environment:
- DISABLE_PHP_FPM=true
- DISABLE_NGINX=true
- DISABLE_HORIZON=false
- DISABLE_SCHEDULER=true
scheduler:
image: escolalms/api:latest
networks:
- escola_lms
volumes:
- ./storage:/var/www/html/storage
- ./.env:/var/www/html/.env
environment:
- DISABLE_PHP_FPM=true
- DISABLE_NGINX=true
- DISABLE_HORIZON=true
- DISABLE_SCHEDULER=false
```