Backend
Monolithic backend of IoC scraper service
Deploy
Native deployment
- Install python 3.10
- Clone repository
git clone https://git.miem.hse.ru/indicators-parser-saas/backend.git - Install dependencies
pip install -r requirements.txt - Set enviroment variables in .env file
- Run development server
python main.py
Docker deployment
- Install docker
- Save enviroment variables in .env file
- Run docker image with .env file mounted
docker run -d --env-file .env -p 8000:8000 --name backend -it registry.miem.hse.ru/indicators-parser-saas/backend - In another terminal run client generation
docker exec -it backend python ./app.py
Settings
| Name | Description | Is required? |
|---|---|---|
DB_URI |
Database URL | ✅ |
GITHUB_CLIENT_ID |
GitHub OAuth client id | ✅ |
GITHUB_CLIENT_SECRET |
GitHub OAuth client secret | ✅ |
JWK_KEY_FILE |
RSA Private and Public key in Json Web Key format (key.jwk by default) |
|
S3_SECRET_KEY |
AWS S3 or S3 like storage static key secret | ✅ |
S3_ACCESS_KEY |
AWS S3 or S3 like storage static access key | ✅ |
S3_REGION_NAME |
AWS S3 or S3 like storage region name | ✅ |
S3_ENDPOINT_URL |
AWS S3 or S3 like storage endpoint URL | ✅ |
S3_REPORTS_FOLDER |
AWS S3 or S3 like storage reports base path | |
S3_BASE_URL |
Base URL for generating not signed URLs | ✅ |
TELEGRAM_API_ID |
Telegram API ID from my.telegram.org | ✅ |
TELEGRAM_API_HASH |
Telegram API hash from my.telegram.org | ✅ |
TELEGRAM_SESSION_NAME |
Telegram session file name (ioc by default) |
Documentation
Documentation is powered by Sphinx and available at Read The Docs