From 04eeb95a8f218944632dee0547babdeef2e42c53 Mon Sep 17 00:00:00 2001 From: ankitjavalkar Date: Wed, 27 Dec 2017 14:10:20 +0530 Subject: Modify README for production --- README_production.rst | 30 ++++++++++++++++++++++-------- 1 file changed, 22 insertions(+), 8 deletions(-) (limited to 'README_production.rst') diff --git a/README_production.rst b/README_production.rst index dec2034..02b2008 100644 --- a/README_production.rst +++ b/README_production.rst @@ -6,6 +6,12 @@ environment. If you wish to take Yaksh on a trial run, here is a [Quickstart Guide] (https://github.com/FOSSEE/online\_test/blob/master/README.md) +################### +Deploying Locally +################### + +Follow these steps to deploy locally on the server. For deployment instructions using Docker see :ref:`deploying-multiple-dockers`. + Pre-Requisite ^^^^^^^^^^^^^ @@ -16,9 +22,6 @@ Pre-Requisite 4. Install Python MySql support 5. Install Apache Server for deployment -Configure MySql server -^^^^^^^^^^^^^^^^^^^^^^ - 1. Create a database named ``yaksh`` by following the steps below :: @@ -153,7 +156,7 @@ To install this app follow the steps below: that this will likely spawn multiple processes as "nobody" depending on the number of server ports specified. - You can also use a Dockerized code server (see below) + You can also use a Dockerized code server, see :ref:`dockerized-code-server`. 4. Now, Run: @@ -179,6 +182,8 @@ To install this app follow the steps below: and user data interactively. You could also "grade" the papers manually if needed. +.. _dockerized-code-server: + Using Dockerized Code Server ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -199,11 +204,17 @@ Using Dockerized Code Server code\_server.py within it), it will also bind the ports of the host with those of the container +.. _deploying-multiple-dockers: + +###################################### Deploying Multiple Dockers -^^^^^^^^^^^^^^^^^^^^^^^^^^ +###################################### -1. Install - `Docker `__ +Follow these steps to deploy and run the Django Server, MySQL instance and Code Server in seperate Docker instances. + +1. Install `Docker `__ + +2. Install `Docker Compose `__ 2. Go to the directory where the project is located at: @@ -244,8 +255,11 @@ Deploying Multiple Dockers invoke clean +.. _add-commands: + +###################################### Additional commands available -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +###################################### We provide several convenient commands for you to use: -- cgit