Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/computate-org/computate-scolaire
https://github.com/computate-org/computate-scolaire
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/computate-org/computate-scolaire
- Owner: computate-org
- License: agpl-3.0
- Created: 2019-03-03T14:43:21.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-12T21:43:37.000Z (about 2 years ago)
- Last Synced: 2024-11-05T15:38:28.659Z (3 months ago)
- Language: Java
- Size: 23 MB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Description
# Prerequisites
## What is the first step to creating my own website?
### Choose a domain name.
https://www.computate.org/enUS/course/001/001-choose-domain-name
For Red Hat employees, see Christopher Tate for details about a domain name you can use for development, or feel free to obtain your own for practice.
## What can I do once I have purchased a domain name?
### Obtain a valid TLS certificate for free, for security and credibility.
https://www.computate.org/enUS/course/001/008-how-to-obtain-free-tls-certificates
For Red Hat employees, see Christopher Tate for details about the TLS certificates you can use for development, or feel free to generate your own for practice.
## Where can I host the project online?
### Red Hat OpenShift Online is the very best open source cloud hosting available.
https://www.openshift.com/products/online/
For Red Hat employees, you can get permission from your manager to create a free OpenShift account to deploy to:
https://employee.openshift.com/register/employee/introduction
# Installation
The installation of the project for both development and production in containers is completely automated with Ansible.
Begin by installing both the ansible and python3 packages.
```bash
sudo yum install -y ansible python3 python3-pip
sudo pip3 install psycopg2
```
If psycopg2 does not install, run:
```bash
sudo pip3 install psycopg2-binary
```
## Ansible on older operating systems.
If you have an older operating system that does not yet support python3, you may struggle to deploy the application on OpenShift in the cloud. The OpenShift Ansible modules seem to require python3 as the system library, so I recommend updating your operating system to something more recent, for example CentOS8 or RHEL8.
On older operating systems, to deploy the development applications you might want to configure ansible for python2.
To deploy to OpenShift, you will want to configure ansible to point to python3.
You might update your ansible configuration like this to make it work:
```
sudo vim /etc/ansible/ansible.cfg
```
```
[defaults]
interpreter_python=/usr/bin/python3
```
Your dependencies might be different on an older operating system.
```bash
sudo yum install -y ansible python python-pip
sudo pip install psycopg2
```
## Ansible training.
For training on ansible and automation, I recommend the following Red Hat course.
By completing the course and taking the exam, you can be a Red Hat Certified Specialist in Ansible Automation.
https://www.redhat.com/en/services/training/do407-automation-ansible-i
## Development installation of computate-scolaire.
### Create an ansible inventory for development.
You will want to create your own directory to store your ansible inventories for both development and production in the cloud.
Create a directory for the computate project with the included ansible scripts.
```bash
sudo install -d -o $USER -g $USER /usr/local/src/computate
```
Create a directory for your development inventory.
```bash
install -d /usr/local/src/computate/ansible/inventories/$USER-$HOSTNAME
```
Create a hosts file for your development inventory.
```bash
echo 'localhost' > /usr/local/src/computate/ansible/inventories/$USER-$HOSTNAME/hosts
```
### Create an ansible vault for the application secrets.
Create and edit an encrypted ansible vault with a password for the host secrets for your development inventory.
```bash
ansible-vault create /usr/local/src/computate/ansible/inventories/$USER-$HOSTNAME/host_vars/$HOSTNAME/vault
ansible-vault edit /usr/local/src/computate/ansible/inventories/$USER-$HOSTNAME/host_vars/$HOSTNAME/vault
```
The contents of the vault will contain the secrets needed to override any default values you want to change in the computate-scolaire defaults defined here.
https://github.com/computate/computate/blob/master/ansible/roles/computate_scolaire/defaults/main.yml
There are descriptions for each of the fields.
There are several sections of fields, including:
- computate-scolaire system defaults
- Ansible defaults
- Zookeeper defaults
- Solr defaults
- PostgreSQL defaults
- computate-medical global defaults
- computate-scolaire US English defaults
- SMTP defaults
- OpenID Connect auth server defaults
- SSL/TLS defaults
To add the neccesary variables to your vault, run:
```bash
cp inventories/computate-scolaire-local/host_vars/localhost/vault inventories/$USER-$HOSTNAME/host_vars/new-host/vault
```
Also, make sure your machine allows ssh. If you are on a linux machine (Fedora):
```bash
yum install -y openssh-server
systemctl start sshd.service
systemctl enable sshd.service
```
### Clone the computate project to run the ansible scripts.
Create a directory for the computate project containing the ansible scripts to run.
```bash
sudo install -d -o $USER -g $USER /usr/local/src/computate
```
Clone the computate project.
```bash
git clone https://github.com/computate-org/computate.git /usr/local/src/computate
```
Change to the computate ansible directory.
```bash
cd /usr/local/src/computate/ansible
```
#### Run the playbook to install a PostgreSQL server on your development computer.
```bash
ansible-playbook computate_postgres.yml -i /usr/local/src/computate/ansible/inventories/$USER-$HOSTNAME/hosts --vault-id @prompt
```
#### Run the playbook to install a Zookeeper cluster manager on your development computer.
```bash
ansible-playbook computate_zookeeper.yml -i /usr/local/src/computate/ansible/inventories/$USER-$HOSTNAME/hosts --vault-id @prompt
```
#### Run the playbook to install a Solr search engine on your development computer.
```bash
ansible-playbook computate_zookeeper.yml -i /usr/local/src/computate/ansible/inventories/$USER-$HOSTNAME/hosts --vault-id @prompt
```
#### Run the playbook to install the computate-scolaire project for development.
```bash
ansible-playbook computate-scolaire.yml -i /usr/local/src/computate/ansible/inventories/$USER-$HOSTNAME/hosts --vault-id @prompt
```
If you are on an older operating system with an older version of ansible, you may run into the following error:
```
ERROR! no action detected in task. This often indicates a misspelled module name, or incorrect module path.
The error appears to have been in '/usr/local/src/computate/ansible/roles/computate-scolaire/tasks/main.yml': line 62, column 3, but may
be elsewhere in the file depending on the exact syntax problem.
The offending line appears to be:
become_user: "{{POSTGRES_BECOME_USER}}"
- name: Grant enUS user access to database
^ here
```
This means that the older version of ansible probably doesn't support the postgresql_pg_hba module and you will have to remove that task before running the ansible playbook successfully.
You will need to configure the PostgreSQL hba configuration yourself in this situation.
# Start the development project in English.
## Maven build the computate-scolaire project.
```bash
cd /usr/local/src/computate-scolaire
mvn clean install
```
## Make sure the Eclipse Marketplace and Git integration are installed.
Help -> Install
Work with: Oxygen - http://download.eclipse.org/releases/oxygen
Or whatever your eclipse release is.
- General Purpose Tools -> Marketplace Client
- Collaboration -> Git integration for Eclipse
## Install the Eclipse maven plugin.
Install from Marketplace "Maven Integration for Eclipse"
## Import the computate-scolaire project into Eclipse.
File -> Import... -> Maven -> Existing Maven Projects
Click [ Next > ]
Root Directory: /usr/local/src/computate-scolaire
Click [ Finish ]
## Eclipse Debug Configuration.
Main Project: computate-scolaire
Main class: org.computate-scolaire.enUS.vertx.AppVertx
Environment Variables:
- configPath: /usr/local/src/computate-scolaire/config/computate-scolaire-enUS.config
- zookeeperHostName: localhost
- zookeeperPort: 2181
# Deploy computate-scolaire in US English to OpenShift.
For training on OpenShift and modern cloud application development, I recommend the following Red Hat course.
By completing the course and taking the exam, you can be a Red Hat Certified Specialist in OpenShift Application Development.
https://www.redhat.com/en/services/training/do288-red-hat-openshift-development-i-containerizing-applications
### Create an ansible inventory for production.
You will want to create your own directory to store your ansible inventories for production in the cloud.
Create a directory for your ansible scripts.
```bash
sudo install -d -o $USER -g $USER /usr/local/src/computate/ansible
```
Create a directory for your production inventory.
```bash
install -d /usr/local/src/computate/ansible/inventories/$USER-openshift
```
Create a hosts file for your production inventory.
```bash
echo 'localhost' > /usr/local/src/computate/ansible/inventories/$USER-openshift/hosts
```
### Create an ansible vault for the application secrets.
Create an encrypted ansible vault with a password for the host secrets for your production inventory.
```bash
ansible-vault edit /usr/local/src/computate/ansible/inventories/$USER-openshift/host_vars/localhost/vault
```
The contents of the vault will contain the secrets needed to override any default values you want to change in the computate-scolaire defaults defined here.
https://github.com/computate/computate/blob/master/ansible/roles/computate_scolaire_openshift_enUS/defaults/main.yml
There are descriptions for each of the fields.
There are several sections of fields, including:
- Ansible defaults
- Zookeeper defaults
- Solr defaults
- PostgreSQL defaults
- computate-medical global defaults
- computate-scolaire US English defaults
- SMTP defaults
- SSL/TLS defaults
- OpenID Connect auth server defaults
Change to the computate ansible directory.
```bash
cd /usr/local/src/computate/ansible
```
Run the playbook to install a PostgreSQL server in your OpenShift environment.
```bash
ansible-playbook postgres_openshift.yml -i /usr/local/src/computate/ansible/inventories/$USER-openshift/hosts --vault-id @prompt
```
Run the playbook to install a Zookeeper cluster manager in your OpenShift environment.
```bash
ansible-playbook computate_zookeeper_openshift.yml -i /usr/local/src/computate/ansible/inventories/$USER-openshift/hosts --vault-id @prompt
```
Run the playbook to install a Solr search engine in your OpenShift environment.
```bash
ansible-playbook computate_zookeeper_openshift.yml -i /usr/local/src/computate/ansible/inventories/$USER-openshift/hosts --vault-id @prompt
```
Run the playbook to install a Red Hat SSO server in your OpenShift environment.
```bash
ansible-playbook redhat_sso_openshift.yml -i /usr/local/src/computate/ansible/inventories/$USER-openshift/hosts --vault-id @prompt
```
Run the playbook to install the computate-scolaire project in your OpenShift environment.
```bash
ansible-playbook computate_scolaire_openshift_enUS.yml -i /usr/local/src/computate/ansible/inventories/$USER-openshift/hosts --vault-id @prompt
```
### You can watch a video and learn more about this project here: https://devpost.com/software/computate-scolaire
# Prerequisites
## What is the first step to creating my own website?
### Choose a domain name.
https://www.computate.org/enUS/course/001/001-choose-domain-name
## What is the best operating system to develop my website?
### Try my favorite, CentOS 7.
https://www.computate.org/enUS/course/001/002-choose-your-operating-system
## How do I try CentOS 7 Linux without replacing my operating system?
### Try CentOS 7 on a VirtualBox virtual machine.
https://www.computate.org/enUS/course/001/003-try-linux-on-a-virtual-machine-on-virtual-box
## How do I install the operating system to start developing my website?
### Every step to install the CentOS 7 operating system.
https://www.computate.org/enUS/course/001/004-how-to-install-centos7
## How do I install the latest version of maven.
### Install maven from the source code.
https://www.computate.org/enUS/course/001/004-how-to-install-the-latest-version-of-maven
## How do I install development tools to develop my website?
### How to install Eclipse IDE the open source way.
https://www.computate.org/enUS/course/001/006-how-to-install-eclipse
## How do I install the latest version of PostgreSQL.
### Install PostgreSQL from the source code.
https://www.computate.org/enUS/course/001/007-how-to-install-the-latest-version-of-postgresql
## What can I do once I have purchased a domain name?
### Obtain a valid TLS certificate for free, for security and credibility.
https://www.computate.org/enUS/course/001/008-how-to-obtain-free-tls-certificates
## How do I try out clustered configuration, requests, events and shared data sources in development?
### Install Zookeeper from the source code.
https://www.computate.org/enUS/course/001/009-how-to-install-the-latest-version-of-zookeeper
## How do I try out a search engine in my project?
### Install Solr from the source code.
https://www.computate.org/enUS/course/001/010-how-to-install-a-recent-version-of-solr-search-engine
## How do I try out some user management software for single sign on applications?
### Install Keycloak from the source code.
Currently a work in progress.
# Installation
```bash
curl https://raw.githubusercontent.com/computate/computate/master/bin/frFR/installer-computate.sh -o ~/Downloads/installer-computate.sh
bash ~/Downloads/installer-computate.sh
curl https://raw.githubusercontent.com/computate/computate-scolaire/master/bin/frFR/installer-computate-scolaire.sh -o ~/Downloads/installer-computate-scolaire.sh
bash ~/Downloads/installer-computate-scolaire.sh
```
# Démarrer le projet en français :
## If you wish to contribute to the project, you will want to configure it in French.
The project is entirely written in French as a first language, and English as a second language.
This ensures proper internationalization is in place through the whole project!
## Eclipse Debug Configuration
Main Project: computate-scolaire
Main class: org.computate.scolaire.frFR.vertx.AppliVertx
Environment Variables:
* configChemin: /usr/local/src/computate-scolaire/config/computate-scolaire.config
* zookeeperNomHote: localhost
* zookeeperPort: 10281
# Configurer les données
```bash
createuser computate -P
psql -c "create database scolaire_frfr; "
psql -c "grant all privileges on database scolaire_frfr to computate; "
/srv/solr-7.1.0/bin/solr create_collection -c scolaire_frfr -n computate
```
## computate-scolaire.config
configChemin: /usr/local/src/computate-scolaire/config/computate-scolaire.config
```ini
appliNom = computate-scolaire
[computate-scolaire]
zookeeperNomHote=localhost
zookeeperPort=10281
langueNom=frFR
appliChemin_enUS=/usr/local/src/computate-scolaire
appliChemin_frFR=/usr/local/src/computate-scolaire
nomDomaine=computate.org
nomEnsembleDomaine=org.computate.scolaire
autresLangues=enUS
suffixeSrcMainJava=/src/main/java
suffixeSrcGenJava=/src/gen/java
cheminsRelatifsARegarder=src/main/java/org/computate/scolaire/frFR
jdbcUrl="jdbc:postgresql://localhost:5432/scolaire_frfr"
jdbcUtilisateur=computate
jdbcMotDePasse="..."
siteNomHote=dev.computate.org
siteUrlBase=https://dev.computate.org:10180
authRoyaume=COMPUTATE.ORG
authRessource=computate.org
authSecret=...
authUrl=https://sso.computate.org/auth
authSslRequis=all
sslJksChemin=/srv/heytate.com/server.jks
sslJksMotDePasse="..."
sitePort=10180
solrUrl=http://localhost:8983/solr/scolaire_frfr
[email protected]
siteEcrireMethodes=html
siteEcrireMethodes=htmlMeta
siteEcrireMethodes=htmlScripts
siteEcrireMethodes=htmlScript
siteEcrireMethodes=htmlStyles
siteEcrireMethodes=htmlStyle
siteEcrireMethodes=htmlBody
siteZone=America/Denver
```
# Start the project in English :
## Eclipse Debug Configuration
Main Project: computate-scolaire
Main class: org.computate.scolaire.enUS.vertx.AppVertx
Environment Variables:
* configPath: /usr/local/src/computate-scolaire/config/computate-scolaire-enUS.config
* zookeeperHostName: localhost
* zookeeperPort: 10281
# Configure the data
```bash
createuser computate -P
psql -c "create database scolaire_enus; "
psql -c "grant all privileges on database scolaire_enus to computate; "
/srv/solr-7.1.0/bin/solr create_collection -c scolaire_enus -n computate
```
## computate-scolaire-enUS.config
configPath: /usr/local/src/computate-scolaire/config/computate-scolaire-enUS.config
```ini
appName = computate-scolaire
[computate-scolaire]
zookeeperHostName=localhost
zookeeperPort=10281
languageName=frFR
appPath_enUS=/usr/local/src/computate-scolaire
appPath_frFR=/usr/local/src/computate-scolaire
domainName=computate.org
domainPackageName=org.computate.scolaire
otherLanguages=enUS
jdbcUrl="jdbc:postgresql://localhost:5432/scolaire_enus"
jdbcUser=computate
jdbcPassword="..."
siteHostName=dev.computate.org
siteBaseUrl=https://dev.computate.org:10380
authRealm=COMPUTATE.ORG
authResource=computate.org
authSecret=...
authUrl=https://sso.computate.org/auth
authSslRequired=all
sslJksPath=/srv/heytate.com/server.jks
sslJksPassword="..."
sitePort=10380
solrUrl=http://localhost:8983/solr/scolaire_enus
[email protected]
siteZone=America/Denver
```
# Deployment
Sample OpenShift deployment yml file to be placed in /usr/local/src/computate-scolaire/src/main/fabric8/deployment.yml:
```yaml
spec:
strategy:
activeDeadlineSeconds: 21600
recreateParams:
timeoutSeconds: 3600
resources: {}
type: Recreate
template:
spec:
containers:
- name: vertx
env:
- name: KUBERNETES_NAMESPACE
valueFrom:
fieldRef:
apiVersion: v1
fieldPath: metadata.namespace
- name: JAVA_OPTIONS
value: '-Dvertx.cacheDirBase=/tmp -Dvertx.jgroups.config=default'
- name: langueNom
value: frFR
- name: zookeeperHostName
value: ...
- name: zookeeperPort
value: 8080
- name: clusterPublicPort
value: 8081
- name: appliChemin_enUS
value: /usr/local/src/computate-scolaire
- name: domainName
value: computate.org
- name: companyName
value: computate.org
- name: jdbcUrl
value: "jdbc:postgresql://...:5432/scolaire_enus"
- name: jdbcUsername
value: computate
- name: jdbcPassword
value: "..."
- name: siteHostName
value: school.computate.org
- name: siteBaseUrl
value: https://school.computate.org
- name: authRealm
value: COMPUTATE.ORG
- name: authResource
value: computate.org
- name: authSecret
value: ...
- name: authUrl
value: https://sso.computate.org/auth
- name: authSslRequired
value: all
- name: sslJksPath
value: /srv/heytate.com/server.jks
- name: sslJksPassword
value: "..."
- name: sitePort
value: 8080
- name: solrUrl
value: http://...:8080/solr/scolaire_enUS
- name: apiContactMail
value: ...
- name: staticBaseUrl
value: https://computate.neocities.org/scolaire
- name: numberExecutors
value: 5
- name: siteZone
value: America/New_York
readinessProbe:
httpGet:
path: /health
port: 8080
scheme: HTTP
initialDelaySeconds: 15
timeoutSeconds: 5
livenessProbe:
httpGet:
path: /health
port: 8080
scheme: HTTP
initialDelaySeconds: 15
timeoutSeconds: 5
ports:
- containerPort: 8080
name: http
protocol: TCP
- containerPort: 8081
name: cluster
protocol: TCP
- containerPort: 9779
name: prometheus
protocol: TCP
- containerPort: 8778
name: jolokia
protocol: TCP
```
# Deploy static files to CDN.
```bash
rsync -r /usr/local/src/computate-scolaire-static/ /usr/local/src/computate.org-static/scolaire/
```
# Certs
```bash
sudo yum install -y letsencrypt
curl https://letsencrypt.org/certs/isrgrootx1.pem.txt -o /usr/local/src/computate-scolaire/config/root.crt
curl https://letsencrypt.org/certs/lets-encrypt-x3-cross-signed.pem.txt -o /usr/local/src/computate-scolaire/config/ca1.crt
curl https://letsencrypt.org/certs/letsencryptauthorityx3.pem.txt -o /usr/local/src/computate-scolaire/config/ca2.crt
sudo certbot -d demo.heytate.com --manual --preferred-challenges dns certonly --server https://acme-v02.api.letsencrypt.org/directory
sudo cp /etc/letsencrypt/live/demo.heytate.com/privkey.pem /usr/local/src/computate-scolaire/config/server.key
sudo cp /etc/letsencrypt/live/demo.heytate.com/fullchain.pem /usr/local/src/computate-scolaire/config/server.crt
sudo chown $USER: /usr/local/src/computate-scolaire/config/server.* /usr/local/src/computate-scolaire/config/root.crt
cat /usr/local/src/computate-scolaire/config/root.crt /usr/local/src/computate-scolaire/config/server.crt > /usr/local/src/computate-scolaire/config/merged.crt
openssl pkcs12 -export -in /usr/local/src/computate-scolaire/config/merged.crt -inkey /usr/local/src/computate-scolaire/config/server.key -out /usr/local/src/computate-scolaire/config/server.p12 -name demo.heytate.com
keytool -importkeystore -srckeystore /usr/local/src/computate-scolaire/config/server.p12 -destkeystore /usr/local/src/computate-scolaire/config/server.jks -srcstoretype pkcs12 -deststoretype pkcs12 -alias demo.heytate.com -destalias demo.heytate.com
rm /usr/local/src/computate-scolaire/config/server.jceks
keytool -genseckey -alias demo.heytate.com -storetype JCEKS -keystore /usr/local/src/computate-scolaire/config/server.jceks
# Reconfigure the Red Hat SSO secret:
base64 /usr/local/src/computate-scolaire/config/server.jks | perl -pe'chomp'
base64 /usr/local/src/computate-scolaire/config/server.jceks | perl -pe'chomp'
# Configure the www.computate.org route:
cat /usr/local/src/computate-scolaire/config/server.crt
cat /usr/local/src/computate-scolaire/config/server.key
cat /usr/local/src/computate-scolaire/config/ca1.crt
```
# Deployment to OpenShift
```bash
cd /usr/local/src/computate-scolaire
mvn clean install
mvn fabric8:deploy -Popenshift
```