diff --git a/README.md b/README.md index cefce59..a86e447 100644 --- a/README.md +++ b/README.md @@ -46,8 +46,8 @@ The easiest way to configure the DreamFactory application is to use docker-compose. This will automatically spin up 4 containers, the DreamFactory application, MySQL container for the system database, Redis container for caching, and a Postgres database with over 100k records preconfigured for testing. ### 1) Clone the df-docker repo -`cd ~/repos` (or wherever you want the clone of the repo to be) -`git clone https://github.com/dreamfactorysoftware/df-docker.git` +`cd ~/repos` (or wherever you want the clone of the repo to be) +`git clone https://github.com/dreamfactorysoftware/df-docker.git` `cd df-docker` ### 2) Edit `docker-compose.yml` (optional) @@ -59,15 +59,15 @@ The easiest way to configure the DreamFactory application is to use docker-compo `docker compose up -d` NOTE: volume df-storage:/opt/dreamfactory/storage is created to store all file based (apps, logs etc.) data from DreamFactory. - This basically stores all data written by DreamFactory (at /opt/dreamfactory/storage location) in the df-storage volume. This + This basically stores all data written by DreamFactory (at /opt/dreamfactory/storage location) in the df-storage volume. This way if you delete your DreamFactory container your data will persist as long as you don't delete the df-storage volume. - - to stop and remove all containers you can use the command - + + to stop and remove all containers you can use the command + docker compose down - - to stop and remove all containers including volumes use - + + to stop and remove all containers including volumes use + docker compose down -v ### 5) Access Admin UI @@ -99,16 +99,17 @@ After you have spun up your DreamFactory instance, take the APP_KEY value from t Set this value as the APP_KEY value in the docker-compose.yml file (line 28), encapsulating it in single quotes, to avoid receiving "The MAC is invalid" errors within your instance should you ever need to rebuild. -## Testing Data -We mount a Postgres container that contains over 100k records to test without connecting your own data sets. To utilize the container you will use the following connection details. +## Use the Included PostgreSQL Database + +We mount a Postgres container that contains over 100k records to test without connecting your own data sets. To generate a REST API for this database, login to your DreamFactory instance and click the `Connect to Database` button on the home page. Choose PostgreSQL, then add an easily recalled namespace such as pgsql. You can enter anything you'd like into the description field. Click `Next` and enter the below connection details and then press the `Create & Test` button: -Host: The host can be found by running the following Docker command: `docker inspect | grep "IPAddress"`
-Port: 5432
-Database Name: dellstore
-Username: postgres
-Password: root_pw
+* Host: example_data +* Port: 5432 +* Database Name: dellstore +* Username: postgres +* Password: root_pw -This will generate a fully documented and secure API from the Postgres container. +This will generate a fully documented and secure API from the Postgres container. To use this API you'll next need to create a role-based access control (RBAC) and API key. Head over to the documentation (see below) for instructions. ## Documentation