40 lines
1.1 KiB
Markdown
40 lines
1.1 KiB
Markdown
# Misael
|
||
|
||
## For dev
|
||
You need to setup a postgres server at localhost:5432, with user misael with password misael-dev
|
||
|
||
Then, you run the database migration `./gradlew flywayMigrate`
|
||
|
||
And finaly we run `./gradlew bootRun`
|
||
|
||
## For deployment
|
||
The compose file is enough.
|
||
|
||
`launcher.sh` checks that the migrations are applied and then runs the spring boot server on port 8080
|
||
|
||
|
||
## OIDC
|
||
|
||
In order to connect to oidc, you need to setup the following options, if `bcom` is your provider name:
|
||
```Yaml
|
||
spring:
|
||
security:
|
||
oauth2:
|
||
client:
|
||
activate: true
|
||
registration:
|
||
bcom:
|
||
provider: bcom
|
||
client-id: misael
|
||
client-secret: "myclientsecret"
|
||
authorization-grant-type: authorization_code
|
||
scope: openid,roles
|
||
provider:
|
||
bcom:
|
||
issuer-uri: "https://auth.example.com/realms/bcom"
|
||
```
|
||
|
||
|
||
## API
|
||
All API requests must be done with POST requests. They will always output a json object, with a boolean
|
||
filed `success`. If `success` is false, a field `message` can give more information on the error. |