Add instructions

This commit is contained in:
Hubert Van De Walle 2020-08-25 08:18:34 +02:00
parent b8e9d4e96e
commit b015f3a97e
2 changed files with 21 additions and 1 deletions

View File

@ -6,4 +6,5 @@ MYSQL_ROOT_PASSWORD=
# #
## can be generated with `openssl rand -base64 32` ## can be generated with `openssl rand -base64 32`
MYSQL_PASSWORD= MYSQL_PASSWORD=
PASSWORD=${MYSQL_PASSWORD} # password should be the same as mysql_password
PASSWORD=

19
README.md Normal file
View File

@ -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.