{"id":13990636,"url":"https://github.com/dreamfactorysoftware/df-docker","last_synced_at":"2025-07-25T05:41:01.404Z","repository":{"id":1987545,"uuid":"41546983","full_name":"dreamfactorysoftware/df-docker","owner":"dreamfactorysoftware","description":"Docker container for DreamFactory.","archived":false,"fork":false,"pushed_at":"2025-07-03T15:50:28.000Z","size":5496,"stargazers_count":70,"open_issues_count":12,"forks_count":59,"subscribers_count":17,"default_branch":"master","last_synced_at":"2025-07-03T16:56:41.284Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dreamfactorysoftware.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2015-08-28T12:47:10.000Z","updated_at":"2025-06-14T06:52:32.000Z","dependencies_parsed_at":"2024-03-20T05:29:45.504Z","dependency_job_id":"e838b977-0d70-4fb7-88e5-2969dd4771ce","html_url":"https://github.com/dreamfactorysoftware/df-docker","commit_stats":null,"previous_names":[],"tags_count":29,"template":false,"template_full_name":null,"purl":"pkg:github/dreamfactorysoftware/df-docker","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dreamfactorysoftware%2Fdf-docker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dreamfactorysoftware%2Fdf-docker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dreamfactorysoftware%2Fdf-docker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dreamfactorysoftware%2Fdf-docker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dreamfactorysoftware","download_url":"https://codeload.github.com/dreamfactorysoftware/df-docker/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dreamfactorysoftware%2Fdf-docker/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266505773,"owners_count":23940019,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-22T02:00:09.085Z","response_time":66,"last_error":null,"robots_txt_status":null,"robots_txt_updated_at":null,"robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-09T13:03:02.768Z","updated_at":"2025-07-25T05:41:01.362Z","avatar_url":"https://github.com/dreamfactorysoftware.png","language":"Shell","funding_links":[],"categories":["Shell"],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e\n    \u003ca href=\"https://dreamfactory.com/\"\u003e\u003cimg src=\"https://raw.githubusercontent.com/dreamfactorysoftware/dreamfactory/master/readme/vertical-logo-fullcolor.png\" alt=\"DreamFactory\" width=\"250\" /\u003e\u003c/a\u003e\n\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n    Docker container for DreamFactory 7.x using Ubuntu 24.04, PHP 8.3 and NGINX.\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n    \u003ca href=\"http://guide.dreamfactory.com/\"\u003eGet Started Guide\u003c/a\u003e ∙ \u003ca href=\"https://genie.dreamfactory.com\"\u003eTry Online\u003c/a\u003e ∙ \u003ca href=\"https://github.com/dreamfactorysoftware/dreamfactory/blob/master/CONTRIBUTING.md\"\u003eContribute\u003c/a\u003e ∙ \u003ca href=\"http://community.dreamfactory.com/\"\u003eCommunity Support\u003c/a\u003e ∙ \u003ca href=\"https://wiki.dreamfactory.com\"\u003eDocs\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n    \u003cimg alt=\"GitHub\" src=\"https://img.shields.io/github/license/dreamfactorysoftware/dreamfactory.svg?style=plastic\"\u003e\n    \u003cimg alt=\"Docker Pulls\" src=\"https://img.shields.io/docker/pulls/dreamfactorysoftware/df-docker.svg?style=plastic\"\u003e\n    \u003cimg alt=\"GitHub Release Date\" src=\"https://img.shields.io/github/release-date/dreamfactorysoftware/dreamfactory.svg?style=plastic\"\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://twitter.com/dfsoftwareinc?lang=en\"\u003e\u003cimg alt=\"Twitter Follow\" src=\"https://img.shields.io/twitter/follow/dfsoftwareinc.svg?style=social\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n## Table of Contents\n\n* \u003ca href=\"#prerequisites\"\u003ePrerequisites\u003c/a\u003e\n* \u003ca href=\"#installation\"\u003eInstallation\u003c/a\u003e\n* \u003ca href=\"#licensed\"\u003eDreamFactory Licensed Edition\u003c/a\u003e\n* \u003ca href=\"#persistent\"\u003ePersisting Data\u003c/a\u003e\n* \u003ca href=\"#testing\"\u003eTesting Data\u003c/a\u003e\n* \u003ca href=\"#documentation\"\u003eDocumentation\u003c/a\u003e\n* \u003ca href=\"#commercial\"\u003eCommercial Licenses\u003c/a\u003e\n* \u003ca href=\"#feedback\"\u003eFeedback\u003c/a\u003e\n\n\u003ca name=\"prerequisites\"\u003e\u003c/a\u003e\n\n## Prerequisites\n\n### Install Docker\n- See: [https://docs.docker.com/installation](https://docs.docker.com/installation)\n\n### Install Docker Compose\n- See [https://docs.docker.com/compose/install](https://docs.docker.com/compose/install)\n\n\u003ca name=\"installation\"\u003e\u003c/a\u003e\n## Installing the DreamFactory Docker Container\nThe 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 \u003ca href=\"#testing\"\u003ePostgres database\u003c/a\u003e with over 100k records preconfigured for testing.\n\n### 1) Clone the df-docker repo\n`cd ~/repos` (or wherever you want the clone of the repo to be)  \n`git clone https://github.com/dreamfactorysoftware/df-docker.git`  \n`cd df-docker`\n\n### 2) Edit `docker-compose.yml` (optional)\n\n### 3) Build images\n`docker-compose build`\n\n### 4) Start containers\n`docker-compose up -d`\n\n    NOTE: volume df-storage:/opt/dreamfactory/storage is created to store all file based (apps, logs etc.) data from DreamFactory.\n    This basically stores all data written by DreamFactory (at /opt/dreamfactory/storage location) in the df-storage volume. This \n    way if you delete your DreamFactory container your data will persist as long as you don't delete the df-storage volume.\n    \n    to stop and remove all containers you can use the command \n    \n        docker-compose down\n    \n    to stop and remove all containers including volumes use \n    \n        docker-compose down -v\n\n### 5) Access Admin UI\nGo 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.\n\n\u003ca name=\"licensed\"\u003e\u003c/a\u003e\n## Running a Licensed Instance\n\n### 1) Add the license files to the `df-docker` directory\n\n### 2) Uncomment lines 25 and 36 of `Dockerfile`\n\n### 3) Add the License Key to line 36 of `Dockerfile`\n\n### 4) Build images\n`docker-compose build`\n\n### 5) Start containers\n`docker-compose up -d`\n\n### 6) Access the app\nGo 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.\n\n\u003ca name=\"persistent\"\u003e\u003c/a\u003e\n## Persisting System Database Configs\nAfter you have spun up your DreamFactory instance, take the APP_KEY value from the `.env` file in `/opt/dreamfactory`. This can be done with the following command:\u003cbr\u003e\n`docker-compose exec web cat .env | grep APP_KEY`\n\nSet 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.\n\n\u003ca name=\"testing\"\u003e\u003c/a\u003e\n## Testing Data\nWe 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.\n\nHost: The host can be found by running the following Docker command: `docker inspect \u003ccontainer-id\u003e | grep \"IPAddress\"`\u003cbr\u003e\nPort: 5432\u003cbr\u003e\nDatabase Name: dellstore\u003cbr\u003e\nUsername: postgres\u003cbr\u003e\nPassword: root_pw\u003cbr\u003e\n\nThis will generate a fully documented and secure API from the Postgres container.\n\n\u003ca name=\"documentation\"\u003e\u003c/a\u003e\n## Documentation\n\nLearn more about DreamFactory's many features by reading our [Getting Started Guide](http://guide.dreamfactory.com/).\nAdditional platform documentation can be found on the [DreamFactory wiki](http://wiki.dreamfactory.com).\n\n\u003ca name=\"commercial\"\u003e\u003c/a\u003e\n## Commercial Licenses\n\nIn need of official technical support? Desire access to REST API generators for SQL Server, Oracle, SOAP, or mobile\npush notifications? Require API limiting and/or auditing? Schedule a demo [with our team](https://www.dreamfactory.com/demo/)!\n\n\u003ca name=\"feedback\"\u003e\u003c/a\u003e\n## Feedback and Contributions\n\nFeedback 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).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdreamfactorysoftware%2Fdf-docker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdreamfactorysoftware%2Fdf-docker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdreamfactorysoftware%2Fdf-docker/lists"}