diff --git a/.env_template b/.env similarity index 98% rename from .env_template rename to .env index 0789ef5873..b4e4cadc59 100644 --- a/.env_template +++ b/.env @@ -5,6 +5,8 @@ ### the COMPOSE_FILE variable each seperated with ':'. If you are on windows, replace all ':' with ';'. ### Reference to Docker's official Docs: https://docs.docker.com/compose/reference/envvars/#compose_file#compose_file +INTELOWL_TAG_VERSION=v1.3.1 + ###### Default (Production) ###### COMPOSE_FILE=docker-compose.yml diff --git a/.gitignore b/.gitignore index c43f1cac1c..e4b7abb2be 100644 --- a/.gitignore +++ b/.gitignore @@ -5,7 +5,6 @@ test_files env_file_app env_file_postgres env_file_integrations -.env venv/ settings/ldap_config.py docker-compose-override.yml diff --git a/Dockerfile_nginx b/Dockerfile_nginx index ceefbed8a0..1b088d9810 100644 --- a/Dockerfile_nginx +++ b/Dockerfile_nginx @@ -1,5 +1,5 @@ # Stage 1: Get build artifacts from intelowl-ng -FROM intelowlproject/intelowl_ng:latest AS angular-prod-build +FROM intelowlproject/intelowl_ng:v1.3.0 AS angular-prod-build # Stage 2: Inject the build artifacts into nginx container FROM library/nginx:1.16.1-alpine diff --git a/docker-compose-with-traefik.yml b/docker-compose-with-traefik.yml index 0dbbb10df8..c5c15d54c6 100644 --- a/docker-compose-with-traefik.yml +++ b/docker-compose-with-traefik.yml @@ -32,7 +32,7 @@ services: - ./env_file_postgres uwsgi: - image: intelowlproject/intelowl:latest + image: intelowlproject/intelowl:${INTELOWL_TAG_VERSION} container_name: intel_owl_uwsgi volumes: - ./configuration/intel_owl.ini:/etc/uwsgi/sites/intel_owl.ini @@ -74,7 +74,7 @@ services: container_name: intel_owl_rabbitmq celery_beat: - image: intelowlproject/intelowl:latest + image: intelowlproject/intelowl:${INTELOWL_TAG_VERSION} container_name: intel_owl_celery_beat restart: unless-stopped command: /usr/local/bin/celery -A intel_owl.celery beat --uid www-data --gid www-data --pidfile=/tmp/celerybeat.pid --schedule=/tmp/celerybeat-schedule @@ -89,7 +89,7 @@ services: - postgres celery_worker: - image: intelowlproject/intelowl:latest + image: intelowlproject/intelowl:${INTELOWL_TAG_VERSION} container_name: intel_owl_celery_worker restart: unless-stopped stop_grace_period: 3m diff --git a/docker-compose.yml b/docker-compose.yml index eeb9726a9e..df891b0611 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -10,7 +10,7 @@ services: - ./env_file_postgres uwsgi: - image: intelowlproject/intelowl:latest + image: intelowlproject/intelowl:${INTELOWL_TAG_VERSION} container_name: intel_owl_uwsgi volumes: - ./configuration/intel_owl.ini:/etc/uwsgi/sites/intel_owl.ini @@ -49,7 +49,7 @@ services: container_name: intel_owl_rabbitmq celery_beat: - image: intelowlproject/intelowl:latest + image: intelowlproject/intelowl:${INTELOWL_TAG_VERSION} container_name: intel_owl_celery_beat restart: unless-stopped command: /usr/local/bin/celery -A intel_owl.celery beat --uid www-data --gid www-data --pidfile=/tmp/celerybeat.pid --schedule=/tmp/celerybeat-schedule @@ -64,7 +64,7 @@ services: - postgres celery_worker: - image: intelowlproject/intelowl:latest + image: intelowlproject/intelowl:${INTELOWL_TAG_VERSION} container_name: intel_owl_celery_worker restart: unless-stopped stop_grace_period: 3m diff --git a/docs/source/Advanced-Usage.md b/docs/source/Advanced-Usage.md index 79e023ce76..e36d6b3940 100644 --- a/docs/source/Advanced-Usage.md +++ b/docs/source/Advanced-Usage.md @@ -90,8 +90,7 @@ table, th, td { -In the project, you can find template files named `.env_template` and `.env_file_integrations_template`. -You have to create new files named `.env` and `env_file_integrations` from these two templates. +In the project, you can find template file `.env_file_integrations_template`. You have to create new file named `env_file_integrations` from this. Docker services defined in the compose files added in `COMPOSE_FILE` variable present in the `.env` file are ran on `docker-compose up`. So, modify it to include only the analyzers you wish to use. Such compose files are available under `integrations/`. \ No newline at end of file diff --git a/docs/source/Contribute.md b/docs/source/Contribute.md index 68f4c324e0..8192fd2b42 100644 --- a/docs/source/Contribute.md +++ b/docs/source/Contribute.md @@ -64,7 +64,7 @@ which can be queried from the main Django API. * The dockerfile should be placed at `./integrations//Dockerfile`. * A docker-compose file should be placed under `./integrations` with the name `docker-compose..yml` * If your docker-image uses any environment variables, add them in the [`env_file_integrations_template`](https://github.com/intelowlproject/IntelOwl/blob/develop/env_file_integrations_template) -* Ultimately, append the name of your docker-compose file in the `COMPOSE_FILE` variables specified in [`.env_template`](https://github.com/intelowlproject/IntelOwl/blob/develop/env_file_integrations_template). The reason for doing this is so that this service remains optional to the end-user. +* Ultimately, append the name of your docker-compose file in the `COMPOSE_FILE` variables specified in [`.env`](https://github.com/intelowlproject/IntelOwl/blob/develop/.env). The reason for doing this is so that this service remains optional to the end-user. * Rest of the steps remain same as given under "How to add a new analyzer". ### Create a pull request diff --git a/docs/source/Installation.md b/docs/source/Installation.md index a720d5789f..c09d2fce49 100644 --- a/docs/source/Installation.md +++ b/docs/source/Installation.md @@ -19,8 +19,7 @@ cp env_file_app_template env_file_app # (optional) enable all docker-based analyzers cp env_file_app_integrations_template env_file_app_integrations -cp .env_template .env -# in .env file comment line 10 and uncomment line 13 +# in `.env` file comment line 12 and uncomment line 15 # start the app docker-compose up -d @@ -221,14 +220,13 @@ Then you can add other users directly from the Django Admin Interface after havi To update the project with the most recent available code you have to follow these steps: ```bash -docker pull intelowlproject/intelowl_ng:latest -> updates the webclient -cd && git pull -> updates the project -docker-compose down && docker-compose up -d -> restart the IntelOwl application +cd && git pull -> updates the project +docker-compose down && docker-compose up --build -d -> restart the IntelOwl application ``` -#### Updating to v1.3.0 from any prior version +#### Updating to >v1.3.x from any prior version -If you are updating to [v1.3.0](https://github.com/intelowlproject/IntelOwl/releases/tag/v1.3.0) from any prior version, you need to execute a helper script so that the old data present in the database doesn't break. +If you are updating to >[v1.3.0](https://github.com/intelowlproject/IntelOwl/releases/tag/v1.3.0) from any prior version, you need to execute a helper script so that the old data present in the database doesn't break. 1. Follow the above updation steps, once the docker containers are up and running execute the following in a new terminal diff --git a/docs/source/conf.py b/docs/source/conf.py index 3e329d666b..da00bc79ff 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -22,7 +22,7 @@ author = "Matteo Lodi" # The full version, including alpha/beta/rc tags -release = "1.3.0" +release = "1.3.1" # -- General configuration --------------------------------------------------- diff --git a/integrations/docker-compose.apk.yml b/integrations/docker-compose.apk.yml index e6b3d1d1e8..7c3fd9c2c7 100644 --- a/integrations/docker-compose.apk.yml +++ b/integrations/docker-compose.apk.yml @@ -6,7 +6,7 @@ version: '3' services: apk_analyzers: - image: intelowlproject/intelowl_apk_analyzers + image: intelowlproject/intelowl_apk_analyzers:${INTELOWL_TAG_VERSION} container_name: intelowl_apk_analyzers restart: unless-stopped expose: diff --git a/integrations/docker-compose.boxjs.yml b/integrations/docker-compose.boxjs.yml index b25e82e551..4acadf64e3 100644 --- a/integrations/docker-compose.boxjs.yml +++ b/integrations/docker-compose.boxjs.yml @@ -6,7 +6,7 @@ version: '3' services: boxjs: - image: intelowlproject/intelowl_boxjs + image: intelowlproject/intelowl_boxjs:${INTELOWL_TAG_VERSION} container_name: intelowl_boxjs restart: unless-stopped expose: diff --git a/integrations/docker-compose.capa.yml b/integrations/docker-compose.capa.yml index 43f450c520..1802ee8db7 100644 --- a/integrations/docker-compose.capa.yml +++ b/integrations/docker-compose.capa.yml @@ -6,7 +6,7 @@ version: '3' services: capa: - image: intelowlproject/intelowl_capa + image: intelowlproject/intelowl_capa:${INTELOWL_TAG_VERSION} container_name: intelowl_capa restart: unless-stopped expose: diff --git a/integrations/docker-compose.peframe.yml b/integrations/docker-compose.peframe.yml index f5b9c5658f..df3526eec3 100644 --- a/integrations/docker-compose.peframe.yml +++ b/integrations/docker-compose.peframe.yml @@ -6,7 +6,7 @@ version: '3' services: peframe: - image: intelowlproject/intelowl_peframe + image: intelowlproject/intelowl_peframe:${INTELOWL_TAG_VERSION} container_name: intelowl_peframe restart: unless-stopped expose: diff --git a/integrations/docker-compose.thug.yml b/integrations/docker-compose.thug.yml index f35722958b..6eec254b21 100644 --- a/integrations/docker-compose.thug.yml +++ b/integrations/docker-compose.thug.yml @@ -6,7 +6,7 @@ version: '3' services: thug: - image: intelowlproject/intelowl_thug + image: intelowlproject/intelowl_thug:${INTELOWL_TAG_VERSION} container_name: intelowl_thug restart: unless-stopped expose: