Merge pull request cakephp#3766 from cakephp/server-shell

Add simple docs for the server shell.
coderader · Feb 21, 2016 · adc059b · adc059b
2 parents 21d40fd + 208a51a
commit adc059b
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 0 deletions.
diff --git a/en/console-and-shells.rst b/en/console-and-shells.rst
@@ -1157,6 +1157,7 @@ More Topics
     console-and-shells/plugin-shell
     console-and-shells/routes-shell
     console-and-shells/upgrade-shell
+    console-and-shells/server-shell
 
 .. meta::
     :title lang=en: Shells, Tasks & Console Tools

diff --git a/en/console-and-shells/server-shell.rst b/en/console-and-shells/server-shell.rst
@@ -0,0 +1,21 @@
+Server Shell
+############
+
+The ``ServerShell`` lets you stand up a simple webserver using the built in PHP
+webserver. While this server is *not* intended for production use it can
+be handy in development when you want to quickly try an idea out and don't want
+to spend time configuring Apache or Nginx. You can start the server shell with::
+
+    $ bin/cake server
+
+You should see the server boot up and attach to port 8765. You can visit the
+CLI server by visiting ``http://localhost:8765``
+in your web-browser. You can close the server by pressing ``CTRL-C`` in your
+terminal.
+
+Changing the Port and Document Root
+===================================
+
+You can customize the port and document root using options::
+
+    $ bin/cake server --port 8080 --document_root path/to/app