Manual OpenBAS install method as described in docs.openbas.io create a partially broken installation

[antoinemzs]

Description

When manually deploying OpenBAS as per instructions found in https://docs.openbas.io/latest/deployment/installation/#manual-installation, the resulting installation will not be able to locate agent binaries.

Environment

Latest OpenBAS as of writing: 1.10.1

Reproducible Steps

Follow steps here: When manually deploying OpenBAS as per instructions found in https://docs.openbas.io/latest/deployment/installation/#manual-installation, the resulting installation will run with unexpanded Maven @..@ placeholder values treated as literals.

Expected Output

All variables should be expanded.

Actual Output

When manually deploying OpenBAS as per instructions found in https://docs.openbas.io/latest/deployment/installation/#manual-installation, the resulting installation will run with unexpanded Maven @..@ placeholder values treated as literals. This will for example lead OpenBAS to think it is running version literal @project.version@.

Additional information

Current workaround

Deleting variables from the application.properties file provided as a release artifact (e.g. in the archive in the github release) will force Spring to load values for the redacted variables that were expanded at build time.
Example:

# Global configuration
# suppress inspection "SpringBootApplicationProperties"
[email protected]@
- # suppress inspection "SpringBootApplicationProperties"
- [email protected]@

# OpenBAS configuration
[email protected]@
[email protected]@

will cause Spring to load the build-time value, for example 1.10.1 .

Suggested path to resolution

Remove @..@ placeholders from application.properties, or alternatively expand them in the file itself if the intention is to keep providing this file as part of the release artifacts. It is useful to have this file provided as it helps a user discover configuration keys, so we need to be wary that it works out of the box.

Screenshots (optional)

$ java -jar openbas-api.jar 
Standard Commons Logging discovery in action with spring-jcl: please remove commons-logging.jar from classpath in order to avoid potential conflicts
 #######  ########  ######## ##    ## ########     ###     ######
##     ## ##     ## ##       ###   ## ##     ##   ## ##   ##    ##
##     ## ##     ## ##       ####  ## ##     ##  ##   ##  ##
##     ## ########  ######   ## ## ## ########  ##     ##  ######
##     ## ##        ##       ##  #### ##     ## #########       ##
##     ## ##        ##       ##   ### ##     ## ##     ## ##    ##
 #######  ##        ######## ##    ## ########  ##     ##  ######
@project.version@

[RomuDeuxfois]

I new feedback from today:
Even for the installation part, the docs only mention cloning, editing application.properties and running java -jar file.jar . However, we also need to setup minIO, RabbitMQ, Postgres, and then add all these details into the application.properties . This should be included in the documentation

So we need to improv the documentation on the installation part.

[EllynBsc]

Problem already mentioned in this issue , i'll close that one as this one has more info.

[antoinemzs]

For the specific issue sdescribed in OP there's a straightforward fix, but I'd prefer to not cram all "doc is wrong" issues into this one, rather make appropriately scoped issues that can be addressed more easily.