mirror of https://github.com/MISP/misp-modules
chg: [website] readme
parent
ba25204ffb
commit
ee02bb171b
|
@ -1,3 +1,42 @@
|
||||||
# MISP-module website
|
# MISP-module website
|
||||||
|
|
||||||
Use all modules with a dedicate website without any MISP
|
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
|
||||||
|
```
|
||||||
|
|
|
@ -21,15 +21,9 @@ class TestingConfig(Config):
|
||||||
SQLALCHEMY_DATABASE_URI = "sqlite:///misp-module-test.sqlite"
|
SQLALCHEMY_DATABASE_URI = "sqlite:///misp-module-test.sqlite"
|
||||||
WTF_CSRF_ENABLED = False
|
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 = {
|
config = {
|
||||||
'development': DevelopmentConfig,
|
'development': DevelopmentConfig,
|
||||||
'testing': TestingConfig,
|
'testing': TestingConfig,
|
||||||
# 'production': ProductionConfig,
|
|
||||||
'default': DevelopmentConfig
|
'default': DevelopmentConfig
|
||||||
}
|
}
|
||||||
|
|
Binary file not shown.
After Width: | Height: | Size: 40 KiB |
Binary file not shown.
After Width: | Height: | Size: 111 KiB |
|
@ -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
|
|
Loading…
Reference in New Issue