From b12c603291ac48c81da17a7c9bb3684b9e2b6612 Mon Sep 17 00:00:00 2001 From: Kevin McGahey <36458555+thekevinm@users.noreply.github.com> Date: Mon, 30 Jan 2023 13:22:15 -0800 Subject: [PATCH 1/3] Update README.md --- README.md | 100 ++++++++++++++++++++++++++++++++++++++++++------------ 1 file changed, 78 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index fdcf258..6d405e2 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,48 @@ -# df-docker - -Docker container for DreamFactory 4.x using Ubuntu 20.04, PHP 7.4 and NGINX. - +

+ DreamFactory +

+ +

+ Docker container for DreamFactory 4.x using Ubuntu 20.04, PHP 7.4 and NGINX. +

+ +

+ Get Started Guide ∙ Try Online ∙ Contribute ∙ Community Support ∙ Docs +

+ +

+ GitHub + Docker Pulls + GitHub Release Date +

+ +

+ Twitter Follow +

+ +## Table of Contents + +* Prerequisites +* Installation +* DreamFactory Licensed Edition +* Persisting Data +* Testing Data +* Documentation +* Commercial Licenses +* Feedback + + ## Prerequisites -### Get Docker +### Install Docker - See: [https://docs.docker.com/installation](https://docs.docker.com/installation) -### Get Docker Compose +### Install Docker Compose - See [https://docs.docker.com/compose/install](https://docs.docker.com/compose/install) -### Persisting MySQL Data -After you have spun up your DreamFactory instance, take the APP_KEY value from the `.env` file in `/opt/dreamfactory` and then set this value as the APP_KEY value in the docker-compose.yml file (line 19) to avoid receiving "The MAC is invalid" errors within your instance should you ever need to rebuild. - -## Configuration method docker-compose -The easiest way to configure the DreamFactory application is to use docker-compose. + +## Installing the DreamFactory Docker Container +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) @@ -40,16 +68,14 @@ The easiest way to configure the DreamFactory application is to use docker-compo to stop and remove all containers including volumes use docker-compose down -v - -### 5) Add an entry to /etc/hosts -`127.0.0.1 dreamfactory.app` -### 6) Access the app -Go to 127.0.0.1 in your browser. It will take some time the first time. You will be asked to create your first admin user. +### 5) Access Admin UI +Go to `127.0.0.1` in your browser. It will take some time upon building, but you will be asked to create your first admin user. -## Running a licensed instance + +## Running a Licensed Instance -### 1) Add the upgraded composer files to the df-docker directory +### 1) Add the license files to the `df-docker` directory ### 2) Uncomment lines 12 and 21 of `Dockerfile` @@ -61,8 +87,38 @@ Go to 127.0.0.1 in your browser. It will take some time the first time. You will ### 5) Start containers `docker-compose up -d` -### 6) Add an entry to /etc/hosts -`127.0.0.1 dreamfactory.app` +### 6) Access the app +Go to `127.0.0.1` in your browser. It will take some time upon building, but you will be asked to create your first admin user. + + +## Persisting System Database Configs +After you have spun up your DreamFactory instance, take the APP_KEY value from the `.env` file in `/opt/dreamfactory` and then set this value as the APP_KEY value in the docker-compose.yml file (line 19) 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. + +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
+ +This will generate a fully documented and secure API from the Postgres container. + + +## Documentation + +Learn more about DreamFactory's many features by reading our [Getting Started Guide](http://guide.dreamfactory.com/). +Additional platform documentation can be found on the [DreamFactory wiki](http://wiki.dreamfactory.com). + + +## Commercial Licenses + +In need of official technical support? Desire access to REST API generators for SQL Server, Oracle, SOAP, or mobile +push notifications? Require API limiting and/or auditing? Schedule a demo [with our team](https://www.dreamfactory.com/demo/)! + + +## Feedback and Contributions -### 7) Access the app -Go to 127.0.0.1 in your browser. It will take some time the first time. You will be asked to create your first admin user. +Feedback is welcome on our [forum](http://community.dreamfactory.com/) or in the form of pull requests and/or issues. Contributions should follow the strategy outlined in ["Contributing to a project"](http://help.github.com/articles/fork-a-repo#contributing-to-a-project). From 41f170f0b0380a690f0cf18537ce6727d9d4bd83 Mon Sep 17 00:00:00 2001 From: Kevin McGahey <36458555+thekevinm@users.noreply.github.com> Date: Mon, 30 Jan 2023 13:23:57 -0800 Subject: [PATCH 2/3] Update docker-compose.yml --- docker-compose.yml | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/docker-compose.yml b/docker-compose.yml index 8bf91c8..7c547bc 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -9,6 +9,13 @@ services: image: mysql:5.7 volumes: - df-mysql:/var/lib/mysql + + example_data: + environment: + DATASETS: pagila + POSTGRES_PASSWORD: root_pw + image: aa8y/postgres-dataset + redis: image: redis @@ -65,4 +72,4 @@ volumes: df-storage: driver: local df-mysql: - driver: local \ No newline at end of file + driver: local From 265d42b4f7afdb493a4b027c78641b32974692c7 Mon Sep 17 00:00:00 2001 From: Kevin McGahey <36458555+thekevinm@users.noreply.github.com> Date: Mon, 30 Jan 2023 13:44:26 -0800 Subject: [PATCH 3/3] Update docker-compose.yml --- docker-compose.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docker-compose.yml b/docker-compose.yml index 7c547bc..84ef3e0 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -10,7 +10,7 @@ services: volumes: - df-mysql:/var/lib/mysql - example_data: + example_data: environment: DATASETS: pagila POSTGRES_PASSWORD: root_pw