See full documentation and requirements at https://confluence.elearning.sumdu.edu.ua/x/GQAM
Project is written on Java 16 (17 work to). Project requires maven (bundled with Intelj Idea or standalone), PostgreSQL 13+, GIT
Clone this (or you command) GIT repository to your computer :)
- Download and install postgresql from official site https://www.postgresql.org/download/
- Configure PostgreSQL to be able to get connection from any user via network:
For local development add to pg_hba.conf :
# IPv4 local connections:
host all all 127.0.0.1/32 scram-sha-256
For local server add to pg_hba.conf :
# IPv4 local connections:
host all all 0.0.0.0/0 scram-sha-256
and to postgresql.conf change
listen_addresses = 'localhost'
to
listen_addresses = '*'
Create config file (any name) with values for keys placed blow. All keys are mandatory. All keys can be specified as OS environment variables.
| Key | Value |
|---|---|
| DB.PORT | Postgresql port (By default 5433 or 5432. See postgresql.conf) |
| DB.LOCAL_PATH | Path to all user-generated file (databases, backups, script) |
| DB.HOST | Postgresql address from local connections (Suitable value 127.0.0.1) |
| DB.URL | Postgresql address for external users ( can be same as site domain name or as DB.HOST) |
| DB.NAME | Name of database for Elephant app |
| DB.USERNAME | Postgresql user for all project-ralated tasks |
| DB.PASSWORD | Password for DB.USERNAME user |
| DB.OS_USER | OS User, owner of postgresql process. (By default postgresql for Linux, and any value for Windows). For linux all postgresql tablespace MUST be owned by DB.OS_USER user |
| APP.URL | Application url (including domain, protocol and port, mostly used for mails) |
| APP.PORT | Internal port for application. Port can be different from APP.URL port, if there is any proxy (like nginx) before Elephant |
| EMAIL.HOST | SMTP server for sending mails (For example: smtp.gmail.com) |
| EMAIL.PORT | SMTP port 465 |
| EMAIL.USER | SMTP user |
| EMAIL.PASSWORD | SMPT user password |
| EMAIL.FROM | Value for "mail from" field (mostly same as EMAIL.USER ) |
| DEFAULT_LANG | EN or UK |
| ENV | PRODUCTION or other . In PRODUCTION mode error page does not show stack traces |
Example:
DB.PORT=5433
DB.LOCAL_PATH=c:\\tmp\\elephant_temp\\
DB.HOST=127.0.0.1
DB.URL=127.0.0.1
DB.NAME=elephant
DB.USERNAME=postgres
DB.PASSWORD=test
DB.OS_USER=WINDOWS
APP.URL= http://127.0.0.1:7000
APP.PORT=7000
EMAIL.HOST=smtp.gmail.com
EMAIL.PORT=465
[email protected]
EMAIL.PASSWORD=my-secret-password
[email protected]
DEFAULT_LANG=EN
ENV=PRODUCTION
Before start you must create database %DB.NAME% owned to %DB.USERNAME% and seed it by migrations SQL.
Substitute %KEY% with it's real value.
psql -p %DB.PORT% -h %DB.HOST% -U %DB.USERNAME% -c "create database %DB.NAME% owner %DB.USERNAME%;"
psql -p %DB.PORT% -h %DB.HOST% -U %DB.USERNAME% -d %DB.NAME% < src/main/resources/migrations/*.sql
For linux distribution you must allow do sudo chwon without password for owner of Elephant process.
- Build project
mvn clean install -DskipTest=true - run
java -jar target/elephant.jar %your-config-file%
Kuzikov Borys [email protected]