diff --git a/openbas-api/src/main/resources/application.properties b/openbas-api/src/main/resources/application.properties index 96c5d6fb26..9336818fe5 100644 --- a/openbas-api/src/main/resources/application.properties +++ b/openbas-api/src/main/resources/application.properties @@ -19,10 +19,64 @@ openbas.with-proxy=false #openbas.admin.password=ChangeMe #openbas.admin.token=ChangeMe -#Feature Flag -openbas.disabled-dev-features= +######################## +# RUNTIME DEPENDENCIES # +######################## +# PostgreSQL, MinIO and RabbitMQ must be configured (and running) for OpenBAS to work properly + +### POSTGRESQL settings +### see also: https://docs.openbas.io/latest/deployment/configuration/#postgresql +# connection URL to the PostgreSQL server +# example: jdbc:postgresql://localhost:5432 +spring.datasource.url= +# Username: should be identical to the username set on the database instance +spring.datasource.username=openbas +# Password: the password for the username set above +spring.datasource.password= + +### MINIO settings +### see also: https://docs.openbas.io/latest/deployment/configuration/#s3-bucket +# hostname of the S3 bucket service +minio.endpoint=localhost +# Port of the MinIO server +minio.port=9000 +# Name of the bucket; the default is fine +minio.bucket=openbas +# key and secret for accessing the bucket +minio.access-key= +minio.access-secret= +# S3 configuration +openbas.s3.use-aws-role=false +openbas.s3.sts-endpoint= + +### RABBITMQ settings +### see also: https://docs.openbas.io/latest/deployment/configuration/#rabbitmq +# hostname and port of the RabbitMQ server +openbas.rabbitmq.hostname=localhost +openbas.rabbitmq.port=5672 +openbas.rabbitmq.prefix=openbas +openbas.rabbitmq.user=guest +openbas.rabbitmq.pass=guest +openbas.rabbitmq.vhost=/ +# enable TLS for encrypted connections +openbas.rabbitmq.ssl=false +openbas.rabbitmq.management-port=15672 +# RabbitMQ queue type ("classic" or "quorum") +openbas.rabbitmq.queue-type=classic +# Whether or not the calls to the management plugin of rabbitmq can be insecure +openbas.rabbitmq.management-insecure=true +# if the SSL key is set to true and Insecure Management to false, +# fill in the following settings to enable access +openbas.rabbitmq.trust-store-password= +openbas.rabbitmq.trust.store= + + -# Server configuration + +#Feature Flags +openbas.enabled-dev-features= + +# Web server configuration server.address=0.0.0.0 server.port=8080 server.servlet.context-path=/ @@ -92,14 +146,13 @@ server.tomcat.uri-encoding=UTF-8 spring.freemarker.charset=UTF-8 server.servlet.encoding.charset=UTF-8 -# Database Properties -spring.datasource.url=jdbc:postgresql://... -spring.datasource.username=openbas -spring.datasource.password= +# ORM spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.PostgreSQLDialect spring.jpa.hibernate.ddl-auto=none # spring.jpa.show-sql=true # spring.jpa.properties.hibernate.format_sql=true + +# Database schema migrations spring.flyway.url=${spring.datasource.url} spring.flyway.user=${spring.datasource.username} spring.flyway.password=${spring.datasource.password} @@ -109,7 +162,7 @@ spring.flyway.baseline-on-migrate=true spring.flyway.baseline-version=0 spring.flyway.postgresql.transactional-lock=false -# IA Properties +# AI Properties ai.enabled=false ai.type=mistralai ai.endpoint= @@ -117,15 +170,6 @@ ai.token= ai.model=mistral ai.model_images= -# Minio Properties -minio.endpoint= -minio.bucket=openbas -minio.port=9000 -minio.access-key= -minio.access-secret= -# S3 configuration -openbas.s3.use-aws-role=false -openbas.s3.sts-endpoint= # Logging logging.level.root=fatal @@ -182,18 +226,7 @@ executor.openbas.binaries.version=@project.version@ # INJECTORS # ############# -openbas.rabbitmq.prefix=openbas -openbas.rabbitmq.hostname=localhost -openbas.rabbitmq.vhost=/ -openbas.rabbitmq.ssl=false -openbas.rabbitmq.port=5672 -openbas.rabbitmq.management-port=15672 -openbas.rabbitmq.user=guest -openbas.rabbitmq.pass=guest -openbas.rabbitmq.queue-type=classic -openbas.rabbitmq.management-insecure=true -openbas.rabbitmq.trust-store-password= -openbas.rabbitmq.trust.store= +### /!\ MAKE SURE TO SETUP RABBITMQ (see RabbitMQ section above) # Mail sending config (Always available, mandatory) openbas.default-mailer=no-reply@openbas.io @@ -275,6 +308,8 @@ openbas.expectation.manual.default-score-value=50 #Health check +# a unique random string used when calling the health endpoint +# Example of a call : /api/health?health_access_key=ChangeMe openbas.healthcheck.key=ChangeMe