summaryrefslogtreecommitdiff
path: root/README_production.rst
diff options
context:
space:
mode:
authorankitjavalkar2018-01-02 18:24:27 +0530
committerankitjavalkar2018-01-04 12:51:43 +0530
commit2846e4372bb5d255c9b4405456b133f174916893 (patch)
treea2c030c382ce79d63cb75835954aa4bca2c36cb8 /README_production.rst
parent7d7cc537f908db40ca6f3b10cc2c10d597b2877a (diff)
downloadonline_test-2846e4372bb5d255c9b4405456b133f174916893.tar.gz
online_test-2846e4372bb5d255c9b4405456b133f174916893.tar.bz2
online_test-2846e4372bb5d255c9b4405456b133f174916893.zip
- Update README_production.rst to fix incorrect commands, links and formatting
- Remove README inside docker folder
Diffstat (limited to 'README_production.rst')
-rw-r--r--README_production.rst40
1 files changed, 24 insertions, 16 deletions
diff --git a/README_production.rst b/README_production.rst
index 29d79e5..a9bd55b 100644
--- a/README_production.rst
+++ b/README_production.rst
@@ -3,14 +3,13 @@ Production Deployment
This README provides documentation to help deploy Yaksh in a production
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)
+`Quickstart Guide <https://github.com/FOSSEE/online\_test/blob/master/README.rst>`__
###################
Deploying Locally
###################
-Follow these steps to deploy locally on the server. For deployment instructions using Docker see :ref:`deploying-multiple-dockers`.
+Follow these steps to deploy locally on the server. For deployment instructions using Docker see `Deploying Multiple Dockers <https://github.com/FOSSEE/online_test/blob/add-docker-compose-test/README_production.rst#deploying-multiple-dockers>`__
Pre-Requisite
^^^^^^^^^^^^^
@@ -56,7 +55,10 @@ Installation & Usage
To install this app follow the steps below:
1. Clone this repository and cd to the cloned repo.
- ``$ git clone https://github.com/FOSSEE/online_test.git``
+
+ ::
+
+ $ git clone https://github.com/FOSSEE/online_test.git
2. Rename the ``.sampleenv`` to ``.env``
@@ -98,7 +100,8 @@ 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 :ref:`dockerized-code-server`.
+ You can also use a Dockerized code server, see `Dockerized Code Server <https://github.com/FOSSEE/online_test/blob/add-docker-compose-test/README_production.rst#using-dockerized-code-server>`__
+
6. The ``wsgi.py`` script should make it easy to deploy this using
mod\_wsgi. You will need to add a line of the form:
@@ -109,7 +112,7 @@ To install this app follow the steps below:
to your apache.conf. For more details see the Django docs here:
- https://docs.djangoproject.com/en/1.6/howto/deployment/wsgi/
+ https://docs.djangoproject.com/en/2.0/howto/deployment/wsgi/
7. Create a Superuser/Administrator:
@@ -125,9 +128,7 @@ To install this app follow the steps below:
each user. Users can potentially write output into these that can be
used for checking later.
-10. As admin user you can visit http://desired\_host\_or\_ip/exam/monitor to view results
- and user data interactively. You could also "grade" the papers
- manually if needed.
+10. As admin user you can visit http://desired\_host\_or\_ip/exam/monitor to view results and user data interactively. You could also "grade" the papers manually if needed.
.. _dockerized-code-server:
@@ -137,14 +138,20 @@ Using Dockerized Code Server
1. Install
`Docker <https://docs.docker.com/engine/installation/>`__
-2. Go to the directory where the project is located cd
- /path/to/online\_test
+2. Go to the directory where the project is located
+
+ ::
-3. Create a docker image. This may take a few minutes docker build -t
- yaksh\_code\_server -f ./docker/Dockerfile\_codeserver
+ cd /path/to/online_test
-4. Check if the image has been created using the output of, docker
- images
+3. Create a docker image. This may take a few minutes,
+
+ ::
+
+ docker build -t yaksh_code_server -f ./docker/Dockerfile_codeserver
+
+4. Check if the image has been created using the output of ``docker
+ images``
5. Run the invoke script using the command ``invoke start`` The command
will create and run a new docker container (that is running the
@@ -153,6 +160,7 @@ Using Dockerized Code Server
6. You can use ``invoke --list`` to get a list of all the available commands
+
.. _deploying-multiple-dockers:
######################################
@@ -211,7 +219,7 @@ Follow these steps to deploy and run the Django Server, MySQL instance and Code
::
- invoke clean
+ invoke remove
12. You can use ``invoke --list`` to get a list of all the available commands