Update README.md

README.md

@@ -82,9 +82,9 @@ Please view https://github.com/Frooodle/Stirling-PDF/blob/main/LocalRunGuide.md
 ### Docker
 https://hub.docker.com/r/frooodle/s-pdf
 
-Stirling PDF has 3 different versions, a Full version, Lite and ultra-Lite. Depending on the types of features you use you may want a smaller image to save on space.
+Stirling PDF has 3 different versions, a Full version, Lite, and ultra-Lite. Depending on the types of features you use you may want a smaller image to save on space.
 To see what the different versions offer please look at our [version mapping](https://github.com/Frooodle/Stirling-PDF/blob/main/Version-groups.md)
-For people that dont mind about space optimisation just use latest tag.
+For people that don't mind about space optimization just use the latest tag.
 ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/frooodle/s-pdf/latest?label=Stirling-PDF%20Full)
 ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/frooodle/s-pdf/latest-lite?label=Stirling-PDF%20Lite)
 ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/frooodle/s-pdf/latest-ultra-lite?label=Stirling-PDF%20Ultra-Lite)
@@ -94,19 +94,14 @@ Docker Run
 docker run -d \
   -p 8080:8080 \
   -v /location/of/trainingData:/usr/share/tesseract-ocr/4.00/tessdata \
+  -v /location/of/extraConfigs:/configs \
   --name stirling-pdf \
   frooodle/s-pdf:latest
   
   
   Can also add these for customisation but are not required
-  -v /location/of/extraConfigs:/configs \
+  
   -v /location/of/customFiles:/customFiles \
-  -e APP_HOME_NAME="Stirling PDF" \
-  -e APP_HOME_DESCRIPTION="Your locally hosted one-stop-shop for all your PDF needs." \
-  -e APP_NAVBAR_NAME="Stirling PDF" \
-  -e ALLOW_GOOGLE_VISIBILITY="true" \
-  -e APP_ROOT_PATH="/" \
-  -e APP_LOCALE="en_GB" \
 ```
 Docker Compose
 ```
@@ -118,15 +113,8 @@ services:
       - '8080:8080'
     volumes:
       - /location/of/trainingData:/usr/share/tesseract-ocr/4.00/tessdata #Required for extra OCR languages
-#      - /location/of/extraConfigs:/configs
+      - /location/of/extraConfigs:/configs
 #      - /location/of/customFiles:/customFiles/
-#    environment:
-#      APP_LOCALE: en_GB
-#      APP_HOME_NAME: Stirling PDF
-#      APP_HOME_DESCRIPTION: Your locally hosted one-stop-shop for all your PDF needs.
-#      APP_NAVBAR_NAME: Stirling PDF
-#      APP_ROOT_PATH: /
-#      ALLOW_GOOGLE_VISIBILITY: true
 
 ```
 
@@ -158,46 +146,74 @@ https://github.com/Frooodle/Stirling-PDF/blob/main/HowToAddNewLanguage.md
 
 And please create a PR to merge it back in so others can use it! 
 
-Also please note as i add new features i will google translate existing languages so that they dont lose support. This could mean that new features need grammer corrections as added.
-
 ## How to View
 1. Open a web browser and navigate to `http://localhost:8080/`
 2. Use the application by following the instructions on the website.
 
 
-## Customize App
+## Customisation
-Stirling PDF allows easy customization of the visible application name.
+Stirling PDF allows easy customization of the app.
-Simply use environment variables APP_HOME_NAME, APP_HOME_DESCRIPTION and APP_NAVBAR_NAME with Docker or Java. 
+Includes things like
-If running Java directly, you can also pass these as properties using -D arguments.
+- Custom application name
+- Custom slogans, icons, images, and even custom HTML (via file overrides)
+There are two options for this, either using the generated settings file ``settings.yml``
+This file is located in the ``/configs`` directory and follows standard YAML formatting
+Environment variables are also supported and would override the settings file
+For example in the settings.yml you have
+```
+system:
+  defaultLocale: 'en-US'
+```
+To have this via an environment variable you would have ``SYSTEM_DEFAULTLOCALE``
 
-Using the same method you can also change 
+The Current list of settings is
+```
+security:
+  enableLogin: true # set to 'true' to enable login
+  csrfDisabled: true #enables/disables csrf protection 
+
+system:
+  defaultLocale: 'en-US' # Set the default language (e.g. 'de-DE', 'fr-FR', etc)
+  googlevisibility: false # 'true' to allow Google visibility, 'false' to disallow
+  rootPath: / # Set the application's root URI (e.g. pdf-app for  http://localhost/pdf-app)
+  customstaticFilePath: '/customFiles/static/' # Directory path for custom static files
+  maxFileSize: 2000 # Set the maximum file size in MB
+
+ui:
+  homeName:  # Application's visible name
+  homeDescription:  # Short description or tagline.
+  navbarName:  # Name displayed on the navigation bar
+
+endpoints:
+  toRemove: [] # List individual endpoints to disable (e.g. ['img-to-pdf', 'remove-pages'])
+  groupsToRemove: [] # List groups of endpoints to disable (e.g. ['LibreOffice']) view groups.md for more info
+
+metrics:
+  enabled: true 
+```
+### Extra notes
+- Endpoints. Currently, the endpoints ENDPOINTS_TO_REMOVE and GROUPS_TO_REMOVE can include comma separate lists of endpoints and groups to disable as example ENDPOINTS_TO_REMOVE=img-to-pdf,remove-pages would disable both image-to-pdf and remove pages, GROUPS_TO_REMOVE=LibreOffice Would disable all things that use LibreOffice. You can see a list of all endpoints and groups [here](https://github.com/Frooodle/Stirling-PDF/blob/main/groups.md) 
+- customStaticFilePath. Customise static files such as the app logo by placing files in the /customFiles/static/ directory. An example of customising app logo is placing a /customFiles/static/favicon.svg to override current SVG. This can be used to change any images/icons/css/fonts/js etc in Stirling-PDF
 
-- The default language by providing APP_LOCALE with values like de-DE fr-FR or ar-AR (Note the - character not _ ) to select your default language (Will always default to English on invalid locale) Current accepted locales can be seen above in the Want to add your own language section
-- Enable/Disable search engine visiblility with ALLOW_GOOGLE_VISIBILITY with true / false values. Default disable visiblility.
-- Change root URI for Stirling-PDF ie change server.com/ to server.com/pdf-app by running APP_ROOT_PATH as pdf-app
-- Disable and remove endpoints and functionality from Stirling-PDF. Currently the endpoints ENDPOINTS_TO_REMOVE and GROUPS_TO_REMOVE can include comma seperated lists of endpoints and groups to disable as example ENDPOINTS_TO_REMOVE=img-to-pdf,remove-pages would disable both image to pdf and remove pages, GROUPS_TO_REMOVE=LibreOffice Would disable all things that use LibreOffice. You can see a list of all endpoints and groups [here](https://github.com/Frooodle/Stirling-PDF/blob/main/groups.md) 
-- Change the max file size allowed through the server with the environment variable MAX_FILE_SIZE. default  2000MB
-- Customise static files such as app logo by placing files in the /customFiles/static/ directory. Example to customise app logo is placing a /customFiles/static/favicon.svg to override current SVG. This can be used to change any images/icons/css/fonts/js etc in Stirling-PDF
-- Enable/Disable metric api endpoints with ENABLE_API_METRICS. Default enabled
 
 ## API
 For those wanting to use Stirling-PDFs backend API to link with their own custom scripting to edit PDFs you can view all existing API documentation
 [here](https://app.swaggerhub.com/apis-docs/Frooodle/Stirling-PDF/) or navigate to /swagger-ui/index.html of your stirling-pdf instance for your versions documentation (Or by following the API button in your settings of Stirling-PDF)
 
 
-## Login authentication (CURRENTLY ALPHA TAG ONLY)
+## Login authentication
 ### Prerequisites: 
 - User must have the folder ./configs volumed within docker so that it is retained during updates.
-- The environment variable 'login.enabled' must be set to true
+- Docker uses must download the security jar version by setting ``DOCKER_ENABLE_SECURITY`` to ``true`` in environment variables. 
-- The environment variables "INITIAL_USERNAME" and "INITIAL_PASSWORD" must also be populated (only required on first boot to create initial user, ignored after.)
+- Now the initial user must be generated. Navigate to your settings.yaml and configure your security settings along with the username and password (only required on the first boot to create the initial user, ignored after.). Alternatively, you can set these via the environment variables ``SECURITY_ENABLELOGIN : true`` ``SECURITY_INITIALLOGIN_USERNAME: username`` ``SECURITY_INITIALLOGIN_PASSWORD: password``
 
-Once the above has been done, on restart a new stirling-pdf-DB.mv.db will show if everything worked.
+Once the above has been done, on restart, a new stirling-pdf-DB.mv.db will show if everything worked.
 
 When you login to Stirling PDF you will be redirected to /login page to login with those credentials. After login everything should function as normal
 
-To access your account settings go to Account settings in the settings cog menu (top right in navbar) this Account settings menu is also where you find your API key.
+To access your account settings go to Account settings in the settings cog menu (top right in navbar) This Account settings menu is also where you find your API key.
 
-To add new users go to bottom of Account settings and hit 'Admin Settings', here you can add new users. The different roles mentioned within this are for rate limiting. This is a Work in progress which will be expanding on more in future
+To add new users go to the bottom of Account settings and hit 'Admin Settings', here you can add new users. The different roles mentioned within this are for rate limiting. This is a Work in progress which will be expanding on more in future
 
 For API usage you must provide a header with 'X-API-Key' and the associated API key for that user.