Merge pull request #75 from BBVA/develop

add quickstart docs

docker-compose.yml

@@ -14,26 +14,3 @@ services:
     image: redis:3-alpine
     ports:
       - 6379:6379
-
-#  patton:
-#    image: bbvalabs/patton:latest
-#    ports:
-#      - 8000:80
-#    environment:
-#      - "PATTON_DB_URL=postgres+psycopg2://postgres:postgres@postgres:5433/patton"
-#      - PATTON_HTTP_PORT=80
-#      - PATTON_DOWNLOAD_FOLDER=/tmp/patton
-#      - PATTON_HTTP_DEBUG=True
-#    depends_on:
-#      - postgres
-#
-#  patton-init:
-#    image: bbvalabs/patton:latest
-#    environment:
-#      - "PATTON_DB_URL=postgres+psycopg2://postgres:postgres@postgres:5433/patton"
-#      - PATTON_HTTP_PORT=80
-#      - PATTON_DOWNLOAD_FOLDER=/tmp/patton
-#      - PATTON_HTTP_DEBUG=True
-#    depends_on:
-#      - patton
-#    command: bash -c "bash ./load_assets.sh ; python main.py -r"

docs/index.rst

@@ -12,6 +12,8 @@ One is the :ref:`userdocs-ref` which include installation and usage, and the oth
 :ref:`developer-ref` which include :ref:`sourcecode-ref` documentation, local environment, testing
 and so on.
 
+
+.. include:: quickstart.rst
 .. include:: user.rst
 .. include:: developer.rst
 .. include:: modules.rst

docs/quickstart.rst

@@ -0,0 +1,63 @@
+Quick start
+===========
+
+This document is a quick introduction for use Deeptracy Service
+
+First of run Patton Server
+++++++++++++++++++++++++++
+
+1 - Install Docker Compose
+-------------------------
+
+`Install Docker Compose from this link <https://docs.docker.com/compose/install/>`_
+
+2 - Create a docker-compose.yml file
+-----------------------
+.. code-block:: file
+
+    version: '3'
+
+    services:
+      deeptracy:
+        image: bbvalabs/deeptracy:latest
+        depends_on:
+          - redis
+          - postgres
+        environment:
+          - BROKER_URI=redis://redis:6379
+          - DATABASE_URI=postgresql://postgres:postgres@postgres:5433/deeptracy
+          - POSTGRES_URI=postgresql://postgres:postgres@postgres:5433
+          - SHARED_VOLUME_PATH=/tmp/deeptracy
+          - LOCAL_PRIVATE_KEY_FILE=/root/.ssh/id_rsa
+          - PATTON_URI=http://localhost:8000
+        volumes:
+          - /var/run/docker.sock:/var/run/docker.sock
+          - /tmp:/tmp
+          - ./private_key:/root/.ssh/
+        privileged: true
+        command: ["./init_patton_db.sh"]
+
+      postgres:
+        image: postgres:9.6-alpine
+        ports:
+          - 5433:5433
+        environment:
+          - POSTGRES_PASSWORD=postgres
+        command: -p 5433
+
+      redis:
+        image: redis:3-alpine
+        ports:
+          - 6379:6379
+
+
+3 - Execute the docker-compose file
+-----------------------
+.. code-block:: bash
+
+  > docker-compose up
+
+4 - ENJOY DEEPTRACY WITH PATTON
+-----------------------
+
+

docs/user.rst

@@ -6,10 +6,6 @@ User's Documentation
 This documentation is for users who want to use Deeptracy. It covers
 two parts, :ref:`installation` and :ref:`usage`
 
-
-
-
-
 .. toctree::
     :maxdepth: 3