Skip to content
GitLab
Projects Groups Topics Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in
  • T tanaguru2020 engine
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributor statistics
    • Graph
    • Compare revisions
  • Issues 0
    • Issues 0
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 0
    • Merge requests 0
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages and registries
    • Packages and registries
    • Package Registry
    • Terraform modules
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • open source
  • tanaguru2020 engine
  • Wiki
  • Installation Guide

Installation Guide · Changes

Page history
Create Installation Guide authored Apr 10, 2026 by severine's avatar severine
Show whitespace changes
Inline Side-by-side
Installation-Guide.md 0 → 100644
View page @ 2f748f1d
Tanaguru rest API use different modules to work.
In order to achieve a complete setup you need to do all modules prerequisites and configuration.
### Please do the following setups :
* [Common setup](./Setup-common)
* [Audit-runner setup](./Setup-audit-runner)
* [Rest setup](./Setup-rest)
* [Oauth setup](./oauth2)
Please read [this](https://gitlab.tanaguru.com/open-source/tanaguru2020-engine/-/tree/master/tanaguru-rest/src/main/resources/docs/api-doc.adoc) in order to use the rest API (master).
### Launch tanaguru2020-engine with script tanaguru-rest-start.sh :
Get the project in a directory and create an another directory "engine-app" for example (with the name you want) :
```sh
git clone https://gitlab.tanaguru.com/open-source/tanaguru2020-engine.git
mkdir engine-app
```
Install Maven (if you don't have it) :
```sh
sudo apt install maven
```
Go into the tanaguru2020-engine folder and launch maven clean install to generate the tar.gz :
```sh
cd tanaguru2020-engine
mvn clean install
```
At the end you should see "BUILD SUCCESS".
Then go into the tanaguru-rest/target/ directory and get the .tar.gz file to move to the directory created before "engine-app" :
```sh
cd tanaguru-rest/target/
mv tanaguru2020-rest-1.0.3.tar.gz ../../../engine-app
cd ../../../engine-app
```
Unzip the file and modify the config files with your configuration (please see modules prerequisites and configuration at the top of the page) :
```sh
tar -xf tanaguru2020-rest-1.0.3.tar.gz
cd tanaguru2020-rest-1.0.3/config
```
* [common.properties](./Setup-common)
* [audit-runner.properties](./Setup-audit-runner)
* [rest.properties](./Setup-rest)
* [Oauth setup](./oauth2)
Then start the engine :
```sh
cd ../bin/
./tanaguru-rest-start.sh
```
Admin user is automatically created on the 1st launch of tanaguru2020-engine : username = admin & password = admin (change after).
Logs are available in folder logs/tanaguru-rest.log.
You can delete the folder tanaguru2020-engine. Your app is now in the "engine-app" folder.
To stop the engine :
```sh
./tanaguru-rest-stop.sh
```
Then you can install the [webapp](https://gitlab.tanaguru.com/open-source/tanaguru2020-webapp). Git clone the webapp, launch "npm install" and then "npm run serve". Also modify configuration file in /public/assets/config/rest.config.js with API_BASE_URL='http://localhost:9002' (with your url of tanaguru-engine installed previously).
### Launch tanaguru2020-engine with Eclipse (Run configurations) :
In Eclipse : Import project from Git.
Warning : eclipse should not be run in root/super user mode.
|Setting|Value|
|----|-----------|
| Project | tanaguru-rest |
|Main class | com.tanaguru.TanaguruRestServer |
|VM arguments |-Dspring.profiles.active=prod <br> -Dspring.config.name=common,audit-runner,rest <br> -Dspring.config.location=/..YOUR PATH../tanaguru2020-engine/tanaguru-resources/src/main/resources/ |
Admin user is automatically created on the 1st launch of tanaguru2020-engine : username = admin & password = admin (change after).
Then you can install the [webapp](https://gitlab.tanaguru.com/open-source/tanaguru2020-webapp). Git clone the webapp, launch "npm install" and then "npm run serve". Also modify configuration file in /public/assets/config/rest.config.js with API_BASE_URL='http://localhost:9002' (with your url of tanaguru-engine installed previously).
\ No newline at end of file
Clone repository
  • Installation Guide
  • Setup audit runner
  • Setup common
  • Setup rest
  • _sidebar
  • Home
  • oauth2