misp-modules/website/README.md

55 lines
1.4 KiB
Markdown
Raw Normal View History

2024-02-07 14:44:21 +01:00
# MISP-module website
2024-02-07 14:39:19 +01:00
2024-02-07 14:44:21 +01:00
Use all modules with a dedicate website without any MISP
2024-02-27 11:20:46 +01:00
2024-02-28 08:53:02 +01:00
![home](https://github.com/MISP/misp-modules/blob/main/website/doc/home_misp_module.png?raw=true)
2024-02-27 11:20:46 +01:00
2024-02-28 08:53:02 +01:00
![query](https://github.com/MISP/misp-modules/blob/main/website/doc/query_misp_module.png?raw=true)
2024-02-27 11:20:46 +01:00
## 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
2024-02-29 10:15:16 +01:00
- `ADMIN_USER`: If True, config page will not be accessible
- `ADMIN_PASSWORD`: Password for Admin user if `ADMIN_USER` is True
2024-03-05 11:30:58 +01:00
Rename `config.cfg.sample` to `config.cfg` then edit it:
- `ADMIN_USER`: If True, config page will not be accessible
- `ADMIN_PASSWORD`: Password for Admin user if `ADMIN_USER` is True
2024-02-27 11:20:46 +01:00
## Launch
```bash
./launch.sh -l
```
2024-02-29 10:15:16 +01:00
## Admin user
If admin user is active, type `/login` in url to access a login page and type the password wrote in `config.py` in `ADMIN_PASSOWRD`.