You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@senssoft.apache.org by le...@apache.org on 2018/03/12 15:58:33 UTC

[19/40] incubator-senssoft git commit: Updated README.md

Updated README.md


Project: http://git-wip-us.apache.org/repos/asf/incubator-senssoft/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-senssoft/commit/b999347e
Tree: http://git-wip-us.apache.org/repos/asf/incubator-senssoft/tree/b999347e
Diff: http://git-wip-us.apache.org/repos/asf/incubator-senssoft/diff/b999347e

Branch: refs/heads/asf-site
Commit: b999347e61fdc88eb4b4710f6e0a4349bb9af55b
Parents: 49ec905
Author: msb3399 <mb...@draper.com>
Authored: Tue Jul 11 16:07:15 2017 -0400
Committer: msb3399 <mb...@draper.com>
Committed: Tue Jul 11 16:07:15 2017 -0400

----------------------------------------------------------------------
 README.md        |  5 +++++
 docker/README.md | 30 ++++++++++++++++++++++++++++++
 2 files changed, 35 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-senssoft/blob/b999347e/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c1558ec
--- /dev/null
+++ b/README.md
@@ -0,0 +1,5 @@
+SensSoft Docker Containers and Website
+--------------------------------------
+
+Specific build instructions located in docker and site folders.
+

http://git-wip-us.apache.org/repos/asf/incubator-senssoft/blob/b999347e/docker/README.md
----------------------------------------------------------------------
diff --git a/docker/README.md b/docker/README.md
new file mode 100644
index 0000000..c5a015b
--- /dev/null
+++ b/docker/README.md
@@ -0,0 +1,30 @@
+How to Build Docker Containers
+------------------------------
+
+1. Install [``Docker``](http://docker.com)
+2. Install ``docker-compose``.
+    ```
+    $ mkdir env
+    $ virtualenv env
+    $ source env/bin/activate 
+    $ pip install -e .[docker]
+    ```
+3. Build and run all ``Docker`` containers.
+    ```
+    $ docker-compose up -d
+    ```
+4. Run a specific ``Docker`` container.
+    ```
+    $ docker-compose up -d site
+    # Note: site container is instrumented w/ userale; all userale logs will be sent to the
+    # elasticsearch docker container. 
+    ```
+5. Verify the deployment by navigating to ``Kibana`` in your favorite browser.
+    ```sh
+    http://localhost:5601
+    ```
+    
+6. Stop all the containers.
+    ```sh
+    $ docker-compose stop 
+    ```
\ No newline at end of file