From 4b48546cea6c894d735f6c9e9d271f4f6a15a57e Mon Sep 17 00:00:00 2001
From: Navan Chauhan <navanchauhan@gmail.com>
Date: Thu, 10 Sep 2020 12:25:30 +0530
Subject: updated Readme to tell about config.ini

Also, moved away from hard-coding tfWorking value
---
 README.md | 105 ++++++++++++++++++++++++++++++++++++++++++++++++++------------
 1 file changed, 85 insertions(+), 20 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index ab6bfda..f502116 100644
--- a/README.md
+++ b/README.md
@@ -40,25 +40,79 @@ Users using apt can install it via `sudo apt install openbabel python3-openbabel
 
 ## 2. Changing the Configuration
 
-Replace the values in `app/__init__.py`, `app/dock-single.py` and `app/dock-docker.py`
-
-## 3. Enabling LSTM Generator
-
-Open `app/views.py`
-
-Make sure you have installed Tensorflow. Replace the following:
-
-```python
-tfWorking = 0
-```
-
-with
-
-```python
-tfWorking = -1
+Replace the values in `config.ini`
+
+Default Values:
+```ini
+[DATABASE]
+HOST = navanspi.duckdns.org
+PORT = 3306
+USER = curieweb
+PASSWORD = curie-web-russian-54
+NAME = curie
+
+[SMTP]
+SERVER = smtp.gmail.com
+PORT = 587
+EMAIL = navanchauhan@gmail.com
+PASSWORD = okrs shoc ahtk idui
+
+[LOGS]
+LOG = True
+SAVE_LOGS = False 
+
+[FILES]
+UPLOAD_FOLDER = ./app/static/uploads
+LOG_FOLDER = ./app/logs/
+
+[EXECUTION]
+INSTANT = True
+
+[FEATURES]
+LSTM = False
 ```
 
-## 4. Adding AR Model Support
+### **Database**
+| Name     | Description         |
+|----------|---------------------|
+| HOST     | MySQL Database Host |
+| PORT     | MySQL Database Port |
+| USER     | Username            |
+| PASSWORD | Password            |
+| NAME     | MySQL Database Name |
+
+### **SMTP**
+| Name     | Description |
+|----------|-------------|
+| SERVER   | SMTP Server |
+| PORT     | SMTP Port   |
+| EMAIL    | Email       |
+| PASSWORD | Password    |
+
+### **LOGS**
+| Name      | Description |
+|-----------|-------------|
+| LOG       | Log         |
+| SAVE_LOGS | SAVE LOGS   |
+
+### **FILES**
+| Name          | Description           |
+|---------------|-----------------------|
+| UPLOAD_FOLDER | Folder to store files |
+| LOG_FOLDER    | Folder to store logs  |
+
+### **EXECUTION**
+| Name          | Description           |
+|---------------|-----------------------|
+| INSTANT | Whether to run the docking jobs instantly (True or False) |
+
+### **FEATURES**
+| Name          | Description           |
+|---------------|-----------------------|
+| LSTM | Enable LSTM Generator (True or False) |
+
+
+## 3. Adding AR Model Support
 
 Make sure you have PyMOL 2.0 or higher
 
@@ -66,13 +120,13 @@ Make sure you have PyMOL 2.0 or higher
 Either download the precompiled binaries from  [COLLADA2GLTF](https://github.com/KhronosGroup/COLLADA2GLTF) or compile it on your own
 
 
-Once you have the `COLLADA2GLTF-bin` file, run the following:
+Once you have the `COLLADA2GLTF-bin` file, copy the file:
 
 ```
 cp COLLADA2GLTF-bin /usr/local/bin/collada2gltf
 ```          
 
-## Running 
+## 4. Running 
 
 ### Without FastAPI
 
@@ -80,4 +134,15 @@ cp COLLADA2GLTF-bin /usr/local/bin/collada2gltf
 
 ### With FastAPI
 
-`gunicorn api:app -k uvicorn.workers.UvicornWorker -b "0.0.0.0:7589"`
\ No newline at end of file
+`gunicorn api:app -k uvicorn.workers.UvicornWorker -b "0.0.0.0:7589"`
+
+### SystemD
+
+**There is a sample systemd file in the misc folder**
+
+Configure the file and then copy it to `/etc/systemd/system`
+
+You can start the server by running `sudo systemctl start curie`
+
+To enable the server to start on boot run `sudo systemctl enable curie`
+
-- 
cgit v1.2.3