diff --git a/.env.dist b/.env.dist index a9f315f..fe2f984 100644 --- a/.env.dist +++ b/.env.dist @@ -6,4 +6,5 @@ MYSQL_ROOT_PASSWORD= # ## can be generated with `openssl rand -base64 32` MYSQL_PASSWORD= -PASSWORD=${MYSQL_PASSWORD} +# password should be the same as mysql_password +PASSWORD= diff --git a/README.md b/README.md new file mode 100644 index 0000000..b76d9fb --- /dev/null +++ b/README.md @@ -0,0 +1,19 @@ +# SimpleNotes, a simple markdown note taking website + +## Requirements + +- Docker +- docker-compose + +## How to run + +- Copy the docker-compose.yml somewhere +- In the same directory, copy the *.env.dist* file and rename it to *.env* +- Edit the variables inside *.env* (see below) +- Run it with `docker-compose up -d` + +## Configuration + +The app is configured with environments variables. +If no match is found within the env, a default value is read from a properties file in /app/src/main/resources/application.properties. +Don't use the default values for secrets ! Every value inside *.env.dist* should be changed.