# **TaranisNG backend setup**
1. Install **Postgresql** database and create database e.g. taranisdb
2. Install **Python 3.7** or later
3. In taranis-ng-common, taranis-ng-collectors and taranis-ng-core install and activate python virtual environment:
`virtualenv -p python3.7 venv`
`source venv/bin/activate`
`pip3 install -e .`
4. Set environment variables for taranis-ng-core:
DB_URL=127.0.0.1:5432;DB_DATABASE=taranisdb;DB_USER=<YOUR-DB-USER>;DB_PASSWORD=<YOUR-DB-USER-PASSWORD>;JWT_SECRET_KEY=F1AE885322F1C
5. Before first run uncomment line with `import test.py` in app.py to create set of test data. After first run comment this line again.
6. Run taranis-ng-core: `python3 run.py`
7. Set environment variables for taranis-ng-collectors:
FLASK_RUN_PORT=5001;API_KEY=12345;TARANIS_NG_CORE_URL=http://127.0.0.1:5000;SSL_VERIFICATION=False
8. Run taranis-ng-collectors: `python3 run.py` and it should collect first set of RSS news items from preconfigured test osint source
# **TaranisNG frontend setup**
1. Install Node.js from https://nodejs.org/en/
1. Set environment variables for taranis-ng-gui:
VUE_APP_TARANIS_NG_URL=http://127.0.0.1:8080;VUE_APP_TARANIS_NG_CORE_API=http://127.0.0.1:5000/api;VUE_APP_TARANIS_NG_LOCALE=en;VUE_APP_TARANIS_NG_CORE_SSE=http://127.0.0.1:5000/sse
3. Install all required packages: `npm install`
4. Run application inside taranis-ng-gui: `npm run serve`
5. In Browser go to: http://127.0.0.1:8080/
6. Test accounts are user with password user and admin with password admin
# **Keycloak setup**
This quick setup guide demonstrates installation for early test purposes running on localhost and default ports. Everything in Keycloak can be reconfigured to specific needs as well as Login screen template.
Keycloak is not needed to run test version of TaranisNG at the moment. You can use default _TestAuthenticator_ instead.
1. Requires JAVA 8 to run so download and install JDK from Oracle or OpenJDK e.g. `apt install openjdk-8-jdk`
2. Download keycloak from https://www.keycloak.org/downloads.html
3. In **keycloak-8.0.2/standalone/configuration/standalone.xml** change http listener port to 8081: `<socket-binding name="http" port="${jboss.http.port:8081}"/>`
4. Run keycloak in **keycloak-8.0.2/bin**: `sudo ./standalone.sh`
5. In browser go to http://127.0.0.1:8081/
6. Create first admin account and log in to Master Realm
7. Choose **ADD REALM** to create realm with the name **taranisng**
8. In taranis-ng realm choose **IMPORT** and import file _realm-export.json_ from **taranis-ng-core** root
9. In CLIENTS choose taranis-ng and regenerate secret in CREDENTIALS -> REGENERATE SECRET and put secret it _into client_secrets.json_ inside **taranis-ng-core** root (_NOTE: this will be properly configurable inside admin interface in the future_)
10. Create 2 users **user** and **admin** in USERS -> ADD USER. These are test users in TaranisNG at the moment.
11. Set `TARANIS_NG_AUTHENTICATOR=keycloak` environment variable for the core service.
12. In **taranis-ng-core** add environment variable OPENID_LOGOUT_URL and set it according to your Keycloak installation e.g. http://127.0.0.1:8081/auth/realms/taranisng/protocol/openid-connect/logout?redirect_uri=<GOTO_URL>
13. In **taranis-ng-gui** add these environment variables to activate external login:
VUE_APP_TARANIS_NG_LOGIN_URL=http://127.0.0.1:5000/api/auth/login;VUE_APP_TARANIS_NG_LOGOUT_URL=http://127.0.0.1:5000/api/auth/logout
Raw data
{
"_id": null,
"home_page": "https://github.com/SK-CERT/Taranis-NG",
"name": "taranis-ng-core",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "",
"author": "SK-CERT, AIT",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/6e/37/b03f39e38e410e18286558c6e69b75fa8b363f12c515e9c4d868a4fe4906/taranis_ng_core-0.1.4.tar.gz",
"platform": "any",
"description": "# **TaranisNG backend setup**\n1. Install **Postgresql** database and create database e.g. taranisdb\n2. Install **Python 3.7** or later\n3. In taranis-ng-common, taranis-ng-collectors and taranis-ng-core install and activate python virtual environment:\n `virtualenv -p python3.7 venv`\n `source venv/bin/activate`\n `pip3 install -e .`\n4. Set environment variables for taranis-ng-core:\n DB_URL=127.0.0.1:5432;DB_DATABASE=taranisdb;DB_USER=<YOUR-DB-USER>;DB_PASSWORD=<YOUR-DB-USER-PASSWORD>;JWT_SECRET_KEY=F1AE885322F1C\n5. Before first run uncomment line with `import test.py` in app.py to create set of test data. After first run comment this line again.\n6. Run taranis-ng-core: `python3 run.py`\n7. Set environment variables for taranis-ng-collectors:\n FLASK_RUN_PORT=5001;API_KEY=12345;TARANIS_NG_CORE_URL=http://127.0.0.1:5000;SSL_VERIFICATION=False\n8. Run taranis-ng-collectors: `python3 run.py` and it should collect first set of RSS news items from preconfigured test osint source\n\n# **TaranisNG frontend setup**\n1. Install Node.js from https://nodejs.org/en/\n1. Set environment variables for taranis-ng-gui:\n VUE_APP_TARANIS_NG_URL=http://127.0.0.1:8080;VUE_APP_TARANIS_NG_CORE_API=http://127.0.0.1:5000/api;VUE_APP_TARANIS_NG_LOCALE=en;VUE_APP_TARANIS_NG_CORE_SSE=http://127.0.0.1:5000/sse\n3. Install all required packages: `npm install`\n4. Run application inside taranis-ng-gui: `npm run serve`\n5. In Browser go to: http://127.0.0.1:8080/\n6. Test accounts are user with password user and admin with password admin\n\n# **Keycloak setup**\nThis quick setup guide demonstrates installation for early test purposes running on localhost and default ports. Everything in Keycloak can be reconfigured to specific needs as well as Login screen template.\nKeycloak is not needed to run test version of TaranisNG at the moment. You can use default _TestAuthenticator_ instead.\n1. Requires JAVA 8 to run so download and install JDK from Oracle or OpenJDK e.g. `apt install openjdk-8-jdk`\n2. Download keycloak from https://www.keycloak.org/downloads.html\n3. In **keycloak-8.0.2/standalone/configuration/standalone.xml** change http listener port to 8081: `<socket-binding name=\"http\" port=\"${jboss.http.port:8081}\"/>`\n4. Run keycloak in **keycloak-8.0.2/bin**: `sudo ./standalone.sh`\n5. In browser go to http://127.0.0.1:8081/\n6. Create first admin account and log in to Master Realm\n7. Choose **ADD REALM** to create realm with the name **taranisng**\n8. In taranis-ng realm choose **IMPORT** and import file _realm-export.json_ from **taranis-ng-core** root\n9. In CLIENTS choose taranis-ng and regenerate secret in CREDENTIALS -> REGENERATE SECRET and put secret it _into client_secrets.json_ inside **taranis-ng-core** root (_NOTE: this will be properly configurable inside admin interface in the future_)\n10. Create 2 users **user** and **admin** in USERS -> ADD USER. These are test users in TaranisNG at the moment.\n11. Set `TARANIS_NG_AUTHENTICATOR=keycloak` environment variable for the core service.\n12. In **taranis-ng-core** add environment variable OPENID_LOGOUT_URL and set it according to your Keycloak installation e.g. http://127.0.0.1:8081/auth/realms/taranisng/protocol/openid-connect/logout?redirect_uri=<GOTO_URL>\n13. In **taranis-ng-gui** add these environment variables to activate external login:\n VUE_APP_TARANIS_NG_LOGIN_URL=http://127.0.0.1:5000/api/auth/login;VUE_APP_TARANIS_NG_LOGOUT_URL=http://127.0.0.1:5000/api/auth/logout\n\n",
"bugtrack_url": null,
"license": "EUPL",
"summary": "Taranis-NG Core",
"version": "0.1.4",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "095eeb32b9f9b98779e56b17cdda1ef066464339d0d5e895f96929cf7bcacafd",
"md5": "f0ea1219b7ad49053d44a223551fa860",
"sha256": "63a55124fb9305943f63ca22740d2a716a02ad95dcfd882426d350a2dfedd851"
},
"downloads": -1,
"filename": "taranis_ng_core-0.1.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f0ea1219b7ad49053d44a223551fa860",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 114308,
"upload_time": "2023-02-07T09:56:19",
"upload_time_iso_8601": "2023-02-07T09:56:19.589810Z",
"url": "https://files.pythonhosted.org/packages/09/5e/eb32b9f9b98779e56b17cdda1ef066464339d0d5e895f96929cf7bcacafd/taranis_ng_core-0.1.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6e37b03f39e38e410e18286558c6e69b75fa8b363f12c515e9c4d868a4fe4906",
"md5": "11b193b8a4440fff06994ae7f6037917",
"sha256": "dfd33afb28c7caceb2465627eb1471ac2c37378ed50a78eafc06d71253d88aa2"
},
"downloads": -1,
"filename": "taranis_ng_core-0.1.4.tar.gz",
"has_sig": false,
"md5_digest": "11b193b8a4440fff06994ae7f6037917",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 81053,
"upload_time": "2023-02-07T09:56:21",
"upload_time_iso_8601": "2023-02-07T09:56:21.215775Z",
"url": "https://files.pythonhosted.org/packages/6e/37/b03f39e38e410e18286558c6e69b75fa8b363f12c515e9c4d868a4fe4906/taranis_ng_core-0.1.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-02-07 09:56:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "SK-CERT",
"github_project": "Taranis-NG",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "taranis-ng-core"
}
JSON
