From 1c2c6d2f9e5df463d0416da6e49e99d06d2ca81b Mon Sep 17 00:00:00 2001
From: Floreal Cabanettes <floreal.cabanettes@inra.fr>
Date: Mon, 19 Feb 2018 15:40:32 +0100
Subject: [PATCH] Update install doc for windows + add config file for windows
---
src/dgenies/INSTALL.md | 21 +++++++++++++++++----
src/dgenies/config_reader.py | 1 +
2 files changed, 18 insertions(+), 4 deletions(-)
diff --git a/src/dgenies/INSTALL.md b/src/dgenies/INSTALL.md
index 14b9d64..2e1923c 100644
--- a/src/dgenies/INSTALL.md
+++ b/src/dgenies/INSTALL.md
@@ -32,8 +32,7 @@ Then, you need to restart your webserver.
-Requirements
-------------
+### Requirements
D-Genies requires python >= 3.5 to run.
@@ -65,6 +64,18 @@ And if you use a cluster (webserver mode):
drmaa==0.7.*
In webserver mode, you must install `mysqlclient` python module (will not be installed automatically) if you use mysql as RDBM.
+
+
+Windows
+-------
+
+We provide an installer to install D-Genies. You can download it [here](#).
+
+All requirements are present inside the package, so you don't have to do anything else.
+
+### System requirements
+
+You need Windows 7 or newer, 64 bits architecture.
How to start
@@ -76,7 +87,7 @@ simultaneously or if you run it on a server, you must run it in webserver mode.
### Standalone mode
-Start with the command below:
+Unix: start with the command below:
dgenies run
@@ -85,6 +96,8 @@ Optional arguments:
`-p <port>` run in a specified port (default: 5000)
`--no-browser` don't start the browser automatically
+Windows: just click on the launcher in the desktop or into the install folder.
+
### Webserver mode
*Note: this mode is only available for Unix systems and will NOT work on MS Windows.*
@@ -159,7 +172,7 @@ Configuration
Changing the default configuration is not required for standalone mode, but you can want to custom some parts of the program.
-Configuration is stored in the `/etc/dgenies/application.properties` file (linux). The file is divided in 8 parts described below.
+Configuration is stored in the `/etc/dgenies/application.properties` file (linux) or in the `application.properties` file of the install folder (windows). The file is divided in 8 parts described below.
To change this file, please copy it into `application.properties.local` (at the same location) to avoid erase of the file on upgrades.
diff --git a/src/dgenies/config_reader.py b/src/dgenies/config_reader.py
index c6fa552..5c36c0c 100644
--- a/src/dgenies/config_reader.py
+++ b/src/dgenies/config_reader.py
@@ -27,6 +27,7 @@ class AppConfigReader:
if os.name == "nt":
config_file.insert(1, os.path.join(sys.executable, '..', "application.properties"))
+ config_file.insert(1, os.path.join(sys.executable, '..', "application.properties.local"))
for my_config_file in config_file_search:
if os.path.exists(my_config_file):
--
GitLab