Commit 973dfbb4 authored by Przemyslaw Kaminski's avatar Przemyslaw Kaminski

[README] some updates to the docs

parent 92e50de6
Pipeline #1010 failed with stage
...@@ -13,9 +13,8 @@ Institute of Paris Île-de-France (ISC-PIF) and its partners. ...@@ -13,9 +13,8 @@ Institute of Paris Île-de-France (ISC-PIF) and its partners.
## Installation ## Installation
Disclaimer: this project is still on development, this is work in Disclaimer: this project is still in development, this is work in
progress. Please report and improve this documentation if you encounter progress. Please report and improve this documentation if you encounter issues.
issues.
### Build Core Code ### Build Core Code
...@@ -33,8 +32,7 @@ curl -sSL https://gitlab.iscpif.fr/gargantext/haskell-gargantext/raw/master/devo ...@@ -33,8 +32,7 @@ curl -sSL https://gitlab.iscpif.fr/gargantext/haskell-gargantext/raw/master/devo
### Add dependencies ### Add dependencies
1. CoreNLP is needed (EN and FR); This dependency will not be needed 1. CoreNLP is needed (EN and FR); This dependency will not be needed soon.
soon.
``` sh ``` sh
./devops/install-corenlp ./devops/install-corenlp
...@@ -69,9 +67,10 @@ Initialization schema should be loaded automatically (from `devops/postgres/sche ...@@ -69,9 +67,10 @@ Initialization schema should be loaded automatically (from `devops/postgres/sche
Change the passwords in gargantext.ini_toModify then move it: Change the passwords in gargantext.ini_toModify then move it:
``` sh
mv gargantext.ini_toModify gargantext.ini mv gargantext.ini_toModify gargantext.ini
```
(.gitignore avoids adding this file to the repository by mistake) (`.gitignore` avoids adding this file to the repository by mistake)
##### Run Gargantext ##### Run Gargantext
...@@ -104,6 +103,15 @@ docker run --rm -it -p 9000:9000 cgenie/corenlp-garg ...@@ -104,6 +103,15 @@ docker run --rm -it -p 9000:9000 cgenie/corenlp-garg
stack exec gargantext-import -- "corpusCsvHal" "user1" "IMT3" gargantext.ini 10000 ./1000.csv stack exec gargantext-import -- "corpusCsvHal" "user1" "IMT3" gargantext.ini 10000 ./1000.csv
``` ```
### Nix
It is also possible to build everything with [Nix](https://nixos.org/) instead of Docker:
``` sh
stack --nix build
stack --nix exec gargantext-import -- "corpusCsvHal" "user1" "IMT3" gargantext.ini 10000 ./1000.csv
stack --nix exec gargantext-server -- --ini gargantext.ini --run Prod
```
## Use Cases ## Use Cases
### Multi-User with Graphical User Interface (Server Mode) ### Multi-User with Graphical User Interface (Server Mode)
...@@ -112,12 +120,14 @@ stack exec gargantext-import -- "corpusCsvHal" "user1" "IMT3" gargantext.ini 100 ...@@ -112,12 +120,14 @@ stack exec gargantext-import -- "corpusCsvHal" "user1" "IMT3" gargantext.ini 100
~/.local/bin/stack --docker exec gargantext-server -- --ini "gargantext.ini" --run Prod ~/.local/bin/stack --docker exec gargantext-server -- --ini "gargantext.ini" --run Prod
``` ```
Then you can log in with `user1:1resu`. Then you can log in with `user1` / `1resu`.
### Command Line Mode tools ### Command Line Mode tools
#### Simple cooccurrences computation and indexation from a list of Ngrams #### Simple cooccurrences computation and indexation from a list of Ngrams
``` sh
stack --docker exec gargantext-cli -- CorpusFromGarg.csv ListFromGarg.csv Ouput.json stack --docker exec gargantext-cli -- CorpusFromGarg.csv ListFromGarg.csv Ouput.json
```
...@@ -10,7 +10,7 @@ SECRET_KEY = PASSWORD_TO_CHANGE ...@@ -10,7 +10,7 @@ SECRET_KEY = PASSWORD_TO_CHANGE
DATA_FILEPATH = FILEPATH_TO_CHANGE DATA_FILEPATH = FILEPATH_TO_CHANGE
# [external] # [external]
# FRAMES # FRAMES (i.e. iframe sources used in various places on the frontend)
FRAME_WRITE_URL = URL_TO_CHANGE FRAME_WRITE_URL = URL_TO_CHANGE
FRAME_CALC_URL = URL_TO_CHANGE FRAME_CALC_URL = URL_TO_CHANGE
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment