Skip to content
Snippets Groups Projects
Commit 70a865d1 authored by Martin Lowe's avatar Martin Lowe :flag_ca:
Browse files

Update for build to strip out passwords from sample env file

Additionally updated docs to prompt user to update password before start
parent b028e5ce
No related branches found
No related tags found
No related merge requests found
setup:;
test -f ".env" || printf "WGAPI_MYSQL_PASSWORD=eclipse_changeme\n \
WGAPI_POSTGRES_DB=ef_wgapi\n \
WGAPI_POSTGRES_USER=root\n \
WGAPI_POSTGRES_PASSWORD=eclipse_changeme\n \
WGAPI_KEYCLOAK_USER=admin\n \
WGAPI_KEYCLOAK_PASSWORD=eclipse_changeme\n \
CONFIG_SECRET_PATH=$PWD/config/secret.properties" > .env
test -f ".env" || cp config/.env.sample .env
test -f "./config/secret.properties" || cp config/secret.properties.sample config/secret.properties
\ No newline at end of file
# eclipsefdn-working-group-api Project
This project uses Quarkus, the Supersonic Subatomic Java Framework.
This project uses Quarkus, the Supersonic Subatomic Java Framework. If you want to learn more about Quarkus, please visit its website: https://quarkus.io/ .
If you want to learn more about Quarkus, please visit its website: https://quarkus.io/ .
## Setting up environment
Before running the application, the initial setup should be observed. The initial setup of this server can be started by running the command `make setup` which will instantiate the secrets file and environment hidden file. To finish the setup of the environment file, open it and add values to the missing fields before starting docker for this project. The missing fields are primarily passwords for the various services running in docker for the project. Set them to some values and save the file. Once finished you can run the docker-compose command for this project successfully.
## Running the application in dev mode
You can run your application in dev mode that enables live coding using:
```shell script
./mvnw compile quarkus:dev
mvn compile quarkus:dev
```
> **_NOTE:_** Quarkus now ships with a Dev UI, which is available in dev mode only at http://localhost:8080/q/dev/.
......@@ -17,7 +19,7 @@ You can run your application in dev mode that enables live coding using:
The application can be packaged using:
```shell script
./mvnw package
mvn package
```
It produces the `quarkus-run.jar` file in the `target/quarkus-app/` directory.
Be aware that it’s not an _über-jar_ as the dependencies are copied into the `target/quarkus-app/lib/` directory.
......@@ -26,7 +28,7 @@ The application is now runnable using `java -jar target/quarkus-app/quarkus-run.
If you want to build an _über-jar_, execute the following command:
```shell script
./mvnw package -Dquarkus.package.type=uber-jar
mvn package -Dquarkus.package.type=uber-jar
```
The application, packaged as an _über-jar_, is now runnable using `java -jar target/*-runner.jar`.
......@@ -35,12 +37,12 @@ The application, packaged as an _über-jar_, is now runnable using `java -jar ta
You can create a native executable using:
```shell script
./mvnw package -Pnative
mvn package -Pnative
```
Or, if you don't have GraalVM installed, you can run the native executable build in a container using:
```shell script
./mvnw package -Pnative -Dquarkus.native.container-build=true
mvn package -Pnative -Dquarkus.native.container-build=true
```
You can then execute your native executable with: `./target/eclipsefdn-working-group-api-1.0.0-SNAPSHOT-runner`
......
WGAPI_MYSQL_PASSWORD=
WGAPI_POSTGRES_DB=ef_wgapi
WGAPI_POSTGRES_USER=root
WGAPI_POSTGRES_PASSWORD=
WGAPI_KEYCLOAK_USER=admin
WGAPI_KEYCLOAK_PASSWORD=
CONFIG_SECRET_PATH=/localdev/eclipsefdn-working-groups-api/config/secret.properties
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment