Improving the quality of readme documentation

- Reformat for sub-headings
- Removed duplicates from properties file
This commit is contained in:
sundayoyeniyi
2020-01-28 21:59:47 +00:00
parent 3a521c0ee0
commit 2b3496ce96
2 changed files with 15 additions and 16 deletions

View File

@@ -4,7 +4,7 @@ This project is a complete starter project you can use to deploy a FHIR server u
Note that this project is specifically intended for end users of the HAPI FHIR JPA server module (in other words, it helps you implement HAPI FHIR, it is not the source of the library itself). If you are looking for the main HAPI FHIR project, see here: https://github.com/jamesagnew/hapi-fhir
# Prerequisites
## Prerequisites
In order to use this sample, you should have:
@@ -12,11 +12,11 @@ In order to use this sample, you should have:
- Oracle Java (JDK) installed: Minimum JDK8 or newer.
- Apache Maven build tool (newest version)
# Running Locally
## Running locally
The easiest way to run this server is to run it directly in Maven using a built-in Jetty server. To do this, change `src/main/resources/hapi.properties` `server_address` and `server.base` with the values commented out as _For Jetty, use this_ and then execute the following command:
```
```bash
mvn jetty:run
```
@@ -26,17 +26,17 @@ Then, browse to the following link to use the server:
If you need to run this server on a different port (using Maven), you can change the port in the run command as follows:
```
```bash
mvn -Djetty.port=8888 jetty:run
```
And replacing 8888 with the port of your choice.
# Configuration
## Configurations
Much of this HAPI starter project can be configured using the properties file in _src/main/resources/hapi.properties_. By default, this starter project is configured to use Derby as the database.
## MySql
### MySql configuration
To configure the starter app to use MySQL, instead of the default Derby, update the hapi.properties file to have the following:
@@ -46,7 +46,7 @@ To configure the starter app to use MySQL, instead of the default Derby, update
- datasource.username=admin
- datasource.password=admin
## PostgreSQL
### PostgreSQL configuration
To configure the starter app to use PostgreSQL, instead of the default Derby, update the hapi.properties file to have the following:
@@ -60,7 +60,7 @@ Because the integration tests within the project rely on the default Derby datab
It is important to use PostgreSQL95Dialect when using PostgreSQL version 10+.
## Overriding Properties
## Overriding application properties
You can override the properties that are loaded into the compiled web app (.war file) making a copy of the hapi.properties file on the file system, making changes to it, and then setting the JAVA_OPTS environment variable on the tomcat server to tell hapi-jpaserver-starter where the overriding properties file is. For example:
@@ -68,7 +68,7 @@ You can override the properties that are loaded into the compiled web app (.war
Note: This property name and the path is case-sensitive. "-DHAPI.PROPERTIES=XXX" will not work.
# Customizing The Web Testpage UI
## Customizing The Web Testpage UI
The UI that comes with this server is an exact clone of the server available at [http://hapi.fhir.org](http://hapi.fhir.org). You may skin this UI if you'd like. For example, you might change the introductory text or replace the logo with your own.
@@ -76,7 +76,7 @@ The UI is customized using [Thymeleaf](https://www.thymeleaf.org/) template file
Several template files that can be customized are found in the following directory: [https://github.com/hapifhir/hapi-fhir-jpaserver-starter/tree/master/src/main/webapp/WEB-INF/templates](https://github.com/hapifhir/hapi-fhir-jpaserver-starter/tree/master/src/main/webapp/WEB-INF/templates)
# Deploying to a Container
## Deploying to a Container
Using the Maven-Embedded Jetty method above is convenient, but it is not a good solution if you want to leave the server running in the background.
@@ -86,7 +86,7 @@ Tomcat is very popular, so it is a good choice simply because you will be able t
To deploy to a container, you should first build the project:
```
```bash
mvn clean install
```
@@ -96,7 +96,7 @@ Again, browse to the following link to use the server (note that the port 8080 m
[http://localhost:8080/hapi-fhir-jpaserver/](http://localhost:8080/hapi-fhir-jpaserver/)
# Deploy with docker compose
## Deploy with docker compose
Docker compose is a simple option to build and deploy container. To deploy with docker compose, you should build the project
with `mvn clean install` and then bring up the containers with `docker-compose up -d --build`. The server can be
@@ -114,7 +114,7 @@ properties in hapi.properties:
- datasource.username=admin
- datasource.password=admin
# Running hapi-fhir-jpaserver-example in Tomcat from IntelliJ
## Running hapi-fhir-jpaserver-example in Tomcat from IntelliJ
Install Tomcat.
@@ -148,7 +148,7 @@ Point your browser (or fiddler, or what have you) to `http://localhost:8080/hapi
It is important to use MySQL5Dialect when using MySQL version 5+.
# Enabling Subscriptions
## Enabling Subscriptions
The server may be configured with subscription support by enabling properties in the [hapi.properties](https://github.com/hapifhir/hapi-fhir-jpaserver-starter/blob/master/src/main/resources/hapi.properties) file:
@@ -158,7 +158,7 @@ The server may be configured with subscription support by enabling properties in
- `subscription.websocket.enabled` - Enables websocket subscriptions. With this enabled, your server will accept incoming websocket connections on the following URL (this example uses the default context path and port, you may need to tweak depending on your deployment environment): [ws://localhost:8080/hapi-fhir-jpaserver/websocket](ws://localhost:8080/hapi-fhir-jpaserver/websocket)
# Using ElasticSearch
## Using Elasticsearch
By default, the server will use embedded lucene indexes for terminology and fulltext indexing purposes. You can switch this to using lucene by editing the properties in [hapi.properties](https://github.com/hapifhir/hapi-fhir-jpaserver-starter/blob/master/src/main/resources/hapi.properties)