1 files changed, 35 insertions, 0 deletions
diff --git a/main/docker/README.md b/main/docker/README.md
new file mode 100755
index 0000000..a2da2e5
--- /dev/null
+++ b/main/docker/README.md
@@ -0,0 +1,35 @@
+# Docker Development Environment
+
+First, install [Docker Compose](https://docs.docker.com/compose/install/).
+
+Second, initialize a new UserFrosting project:
+
+1. Copy `app/sprinkles/sprinkles.example.json` to `app/sprinkles/sprinkles.json`
+2. Run `chmod 777 app/{logs,cache,sessions}` to fix file permissions for web server. (NOTE: File
+   permissions should be properly secured in a production environment!)
+2. Run `docker-compose run composer install` to install all composer modules.
+3. Run `docker-compose run node npm install` to install all npm modules.
+
+Now you can start up the entire Nginx + PHP + MySQL stack using docker with:
+
+    $ docker-compose up
+
+On the first run you need to init the database (your container name may be different depending on the name of your root directory):
+
+    $ docker exec -it -u www-data userfrosting_php_1 bash -c 'php bakery migrate'
+    
+You also need to setup the first admin user (again, your container name may be different depending on the name of your root directory):
+
+    $ docker exec -it -u www-data userfrosting_php_1 bash -c 'php bakery create-admin'
+
+Now visit http://localhost:8570/ to see your UserFrosting homepage!
+
+**This is not (yet) meant for production!!**
+
+You may be tempted to run with this in production but this setup has not been security-hardened. For example:
+
+- Database is exposed on port 8571 so you can access MySQL using your favorite client at localhost:8571. However,
+  the way Docker exposes this actually bypasses common firewalls like `ufw` so this should not be exposed in production.
+- Database credentials are hard-coded so obviously not secure.
+- File permissions may be more open than necessary.
+- It just hasn't been thoroughly tested in the capacity of being a production system.