diff --git a/website/README.md b/website/README.md index ab6fb43..0426c22 100644 --- a/website/README.md +++ b/website/README.md @@ -1,3 +1,42 @@ # MISP-module website Use all modules with a dedicate website without any MISP + +![home](https://github.com/MISP/misp-modules/blob/main/doc/home_misp_module.png?raw=true) + +![query](https://github.com/MISP/misp-modules/blob/main/doc/query_misp_module.png?raw=true) + + + +## Installation + +**It is strongly recommended to use a virtual environment** + +If you want to know more about virtual environments, [python has you covered](https://docs.python.org/3/tutorial/venv.html) + +```bash +sudo apt-get install screen -y +pip install -r requirements.txt +git submodule init && git submodule update ## Initialize misp-objects submodule +python3 app.py -i ## Initialize db +``` + + + +## Config + +Edit `config.py` + +- `SECRET_KEY`: Secret key for the app + +- `FLASK_URL` : url for the instance + +- `FLASK_PORT`: port for the instance + +- `MISP_MODULE`: url and port where misp-module is running + +## Launch + +```bash +./launch.sh -l +``` diff --git a/website/config.py b/website/config.py index 9d64b43..bb49a8a 100644 --- a/website/config.py +++ b/website/config.py @@ -21,15 +21,9 @@ class TestingConfig(Config): SQLALCHEMY_DATABASE_URI = "sqlite:///misp-module-test.sqlite" WTF_CSRF_ENABLED = False - @classmethod - def init_app(cls, app): - print('THIS APP IS IN TESTING MODE. \ - YOU SHOULD NOT SEE THIS IN PRODUCTION.') - config = { 'development': DevelopmentConfig, 'testing': TestingConfig, - # 'production': ProductionConfig, 'default': DevelopmentConfig } diff --git a/website/doc/home_misp_module.png b/website/doc/home_misp_module.png new file mode 100644 index 0000000..193b2d4 Binary files /dev/null and b/website/doc/home_misp_module.png differ diff --git a/website/doc/query_misp_module.png b/website/doc/query_misp_module.png new file mode 100644 index 0000000..3305a5d Binary files /dev/null and b/website/doc/query_misp_module.png differ diff --git a/website/install.sh b/website/install.sh deleted file mode 100755 index 514cb6b..0000000 --- a/website/install.sh +++ /dev/null @@ -1,14 +0,0 @@ -#!/bin/bash - -sudo apt-get update -y -sudo apt-get install virtualenv -y - -virtualenv env -source env/bin/activate - -pip install -r requirements.txt - -git submodule init && git submodule update - -python app.py -i -deactivate