INSTALL.md 1.98 KB
Newer Older
Daniel Caillibaud's avatar
Daniel Caillibaud committed
1 2 3
Installation
============

4
Après avoir récupéré le [projet](https://framagit.org/Sesamath/sesatheque) depuis framagit,
5
choisissez le cas correspondant à votre environnement :
Daniel Caillibaud's avatar
Daniel Caillibaud committed
6

7 8 9 10 11
Installation sans Docker
------------------------

- créer une base mongo (et un user pouvant écrire dedans si vous ne voulez pas laisser la base accessible en écriture à tout le monde)
- avoir un redis joignable
Daniel Caillibaud's avatar
Daniel Caillibaud committed
12
- copier app/_private.example en app/_private
13
- modifier app/_private/config.js pour mettre les accès mongo (si open bar la config de base doit suffire). Vous pouvez surcharger n'importe quel paramètre de configuration de app/config.js
Dono's avatar
Dono committed
14
- si vous utilisez pm2, modifier éventuellement app/_private/pm2App.json5 pour le chemin des logs pm2
15
- installer les dépendances avec `pnpm install` (ou `npm install` ou `yarn install`, mais postinstall utilise pnpm)
Daniel Caillibaud's avatar
Daniel Caillibaud committed
16
- compiler les js client avec `pnpm run build`
17 18 19 20
- lancer l'appli avec au choix
  - `node app/index.js`
  - `npm start` (lancera l'appli avec pm2 s'il est installé)
  - `./script/run` (ajouter -h pour voir les options)
Dono's avatar
Dono committed
21

Daniel Caillibaud's avatar
Daniel Caillibaud committed
22 23
Il est pratique d'ajouter dans votre $PATH les chemins `./node_modules/.bin` et `./scripts`, en ajoutant par ex
`PATH="$PATH:./node_modules/.bin:./scripts"` à votre ~/.bashrc
24

25

26
Installation avec Docker (sans sésalab)
27
---------------------------------------
28

29 30
- `mkdir _private; cp -R _private.example/config.docker.minimale.js _private/config.js`
- modifier le fichier de configuration pour les valeurs obligatoires, mails et clés (cookie et session)
Daniel Caillibaud's avatar
Daniel Caillibaud committed
31 32 33
- build docker `pnpm run docker:build`
- installer les node_modules ` docker-compose run --rm sesatheque pnpm install`
- start avec `pnpm start docker:dev`
34
- une fois que la compil webpack est terminée se rendre à l'adresse http://localhost:3001
35

36
Installation avec Docker, avec sesalab
37 38
--------------------------------------

39 40
@todo créer un docker-compose.sesalab.yml avec un docker/sesalab/Dockerfile
(et rédiger la doc ci-dessous)
41 42 43 44 45

Et ensuite ?
------------

cf doc_src/DEV.md et ses voisins…