Repository navigation
Documentation 'How to start' is misleading #186
Description
Describe the bug
I followed the 'How to start' instructions and unfortunately it didn't work.
To Reproduce
Steps to reproduce the behavior:
- Checkout repo
- Execute './gradlew build'
- Copy config/application.properties to project folder ('cp config/application.properties .')
- Start service ('./builds/libs/TypedPIDMaker-2.1.0.jar')
Expected behavior
The documentation should be correct. ;-)
The file 'application.properties' has to be placed in the same folder as
the jar file or in a subdirectory of this folder called 'config'.
Otherwise the properties file will not be found.
ℹ️ Note:
As './gradlew clean build' will delete your settings its not recommended
to copy the config file into builds/libs directory!
ℹ️ Note:
Typo: The file 'conf/application.properties' doesn't exist.
ℹ️ Note:
It's not recommended to commit application.properties. It should be renamed (e.g.: application-default.properties') to avoid accidentally submitting credentials to Github.
ℹ️ Note:
And last but not least the documentation should be also fixed at https://kit-data-manager.github.io/webpage/typed-pid-maker/installation.html
Activity
Pfeil commentedon Jul 31, 2024
Related: We should give a short summary on how to run/skip the tests explicitly.
Pfeil commentedon Oct 18, 2024
I looked in the Metastore repo to understand how you think I should set it up. But there, it is still perfectly possible to accidentally commit it in a profile-based properties file. I see how this is more convenient and standard, but I do not see how this does protect anyone from committing credentials.
It probably would be the safest to gitignore all
*.propertiesfiles, and exclude the included files, but this will still leave a gap. Can you elaborate on that?VolkerHartmann commentedon Oct 21, 2024
It's true, that it doesn't prevent you from commiting credentials, but why should you change default values to real credentials as you never use these config files for setting up your local test service as it is. At least you have to rename it.
Setting up a config file from scratch is a great effort.
Your .gitignore already ignores application.properties but this doesn't work in posteriori as you commited it before.
You can have a look at your comment in .gitignore for handling instructions. ;-)
Pfeil commentedon Oct 21, 2024
Ok. I will fix this issue in two steps. I pulled in the docker thing because it is somehow related to the getting started story and will also require some additional documentation.
Pfeil commentedon Feb 25, 2025
Docker (compose) documentation notes:
/app/config/data/database