Merge pull request #3 from cisar2218/master

- MinIO added (replacement for local storage)
- Default secret values placed at .env.example file.

Author: cisar2218

.env.example

@@ -0,0 +1,22 @@
+# S3 Bucket
+AWS_ACCESS_KEY_ID=minioadmin
+AWS_SECRET_ACCESS_KEY=minioadmin
+AWS_STORAGE_BUCKET_NAME=dosportal-media
+AWS_S3_ENDPOINT_URL=http://minio:9000
+AWS_S3_REGION_NAME=us-east-1
+AWS_DEFAULT_ACL=public-read
+AWS_S3_CUSTOM_DOMAIN=
+AWS_S3_SIGNATURE_VERSION=s3v4
+MINIO_ROOT_USER=minioadmin
+MINIO_ROOT_PASSWORD=minioadmin
+
+# Django
+SECRET_KEY='django-insecure-)&9q7=6szljptu&2a11rq1k-ofhz1s$nxk&t+f=3xk74(vq4jq'
+
+
+# Postgresql
+POSTGRES_DB=dosportal
+POSTGRES_USER=dosportal_user
+POSTGRES_PASSWORD=dosportal_password
+POSTGRES_HOST=10.5.0.5
+POSTGRES_PORT=5432

DOSPORTAL/settings.py

@@ -10,6 +10,7 @@
 https://docs.djangoproject.com/en/4.2/ref/settings/
 """
 
+import os
 from pathlib import Path
 
 # Build paths inside the project like this: BASE_DIR / 'subdir'.
@@ -59,6 +60,7 @@
     'markdownx',
     'guardian',
     'prettyjson',
+    'storages',
   #  'organizations',
 ]
 
@@ -171,8 +173,21 @@
 STATIC_ROOT = BASE_DIR / 'static'
 STATIC_URL = 'static/'
 
-MEDIA_ROOT = BASE_DIR / 'data/media'
-MEDIA_URL = 'media/'
+
+# S3 Configuration
+AWS_ACCESS_KEY_ID = os.getenv('AWS_ACCESS_KEY_ID', 'minioadmin')
+AWS_SECRET_ACCESS_KEY = os.getenv('AWS_SECRET_ACCESS_KEY', 'minioadmin')
+AWS_STORAGE_BUCKET_NAME = os.getenv('AWS_STORAGE_BUCKET_NAME', 'dosportal-media')
+AWS_S3_ENDPOINT_URL = os.getenv('AWS_S3_ENDPOINT_URL', 'http://minio:9000')
+AWS_S3_REGION_NAME = os.getenv('AWS_S3_REGION_NAME', 'us-east-1')
+AWS_S3_CUSTOM_DOMAIN = os.getenv('AWS_S3_CUSTOM_DOMAIN')
+AWS_DEFAULT_ACL = os.getenv('AWS_DEFAULT_ACL', 'public-read')
+AWS_S3_SIGNATURE_VERSION = os.getenv('AWS_S3_SIGNATURE_VERSION', 's3v4')
+
+# Use S3 for media files
+DEFAULT_FILE_STORAGE = 'storages.backends.s3boto3.S3Boto3Storage'
+MEDIA_URL = f'{AWS_S3_ENDPOINT_URL}/{AWS_STORAGE_BUCKET_NAME}/'
+
 
 REST_FRAMEWORK = {
     # Use Django's standard `django.contrib.auth` permissions,

Dockerfile

@@ -4,7 +4,7 @@ ENV PYTHONDONTWRITEBYTECODE=1
 ENV PYTHONUNBUFFERED=1
 
 RUN apt-get update
-RUN apt-get install -y python3 python3-pip libpq-dev binutils libproj-dev gdal-bin
+RUN apt-get install -y python3 python3-pip python3-setuptools libpq-dev binutils libproj-dev gdal-bin
 #RUN apt-get install -y net-tools
 
 WORKDIR /DOSPORTAL

docker-compose.yml

@@ -2,9 +2,9 @@ networks:
   inet:
     driver: bridge
     ipam:
-     config:
-       - subnet: 10.5.0.0/16
-         gateway: 10.5.0.1
+      config:
+        - subnet: 10.5.0.0/16
+          gateway: 10.5.0.1
   default:
     driver: bridge
     ipam:
@@ -25,38 +25,39 @@ services:
 
   db_dosportal:
     image: postgis/postgis
+    env_file:
+      - .env
     volumes:
       - ./data/dosportal/db_pg:/var/lib/postgresql/data
     environment:
-      - POSTGRES_DB=dosportal
-      - POSTGRES_USER=dosportal_user
-      - POSTGRES_PASSWORD=dosportal_password
+      - POSTGRES_DB=${POSTGRES_DB:-dosportal}
+      - POSTGRES_USER=${POSTGRES_USER:-dosportal_user}
+      - POSTGRES_PASSWORD=${POSTGRES_PASSWORD:-dosportal_password}
     networks:
       inet:
         ipv4_address: 10.5.0.5
 
-
-        
-
   web:
     build:
-     context: .
-     network: host
-#    platform: linux/amd64
-#    command: python manage.py runserver 0.0.0.0:8000
-#    entrypoint: python3 manage.py runserver 0.0.0.0:8000
+      context: .
+      network: host
+    #    platform: linux/amd64
+    #    command: python manage.py runserver 0.0.0.0:8000
+    #    entrypoint: python3 manage.py runserver 0.0.0.0:8000
+    env_file:
+      - .env
     volumes:
       - .:/DOSPORTAL
     ports:
       - "8100:8000"
     depends_on:
       - db_dosportal
       - redis
+      - minio
     networks:
       inet:
         ipv4_address: 10.5.0.6
-#      default:
-
+  #      default:
 
   worker:
     build: .
@@ -74,9 +75,26 @@ services:
   redis:
     image: redis
     volumes:
-      - .:/DOSPORTAL  
+      - .:/DOSPORTAL
     depends_on:
       - db_dosportal
     networks:
       inet:
         ipv4_address: 10.5.0.7
+
+  minio:
+    image: minio/minio
+    env_file:
+      - .env
+    ports:
+      - "9000:9000"
+      - "9001:9001"
+    environment:
+      MINIO_ROOT_USER: ${MINIO_ROOT_USER:-minioadmin}
+      MINIO_ROOT_PASSWORD: ${MINIO_ROOT_PASSWORD:-minioadmin}
+    command: server /data --console-address ":9001"
+    volumes:
+      - ./data/minio:/data
+    networks:
+      inet:
+        ipv4_address: 10.5.0.9

readme.md

@@ -77,3 +77,48 @@ DOSPORTAL is designed to be platform-independent, ensuring accessibility from va
 
 For more information or to contribute to the project, please contact support@ust.cz
 
+## Instructions for Contributors
+
+**Prerequirements:** Docker and Docker Compose for local development.
+
+### Secrets Configuration
+
+Create environment file and setup credentials as needed.
+
+```bash
+cp .env.example .env
+```
+
+### Local Development (Docker Compose)
+
+1. Build images
+
+   ```bash
+   sudo docker compose build web worker
+   ```
+
+2. Start services
+
+   ```bash
+   sudo docker compose up -d
+   ```
+
+3. Create the media bucket in MinIO
+
+   ```bash
+   sudo docker run --rm --net=host \
+     -e MC_HOST_minio=http://minioadmin:minioadmin@localhost:9000 \
+     minio/mc mb --ignore-existing minio/dosportal-media
+   ```
+
+   Or use the console at http://localhost:9001 (minioadmin/minioadmin).
+
+4. Apply migrations
+
+   ```bash
+   sudo docker compose exec web python3 manage.py migrate
+   ```
+
+5. Access services
+   - DOSPORTAL: http://localhost:8100
+   - MinIO console: http://localhost:9001

requirements.txt

@@ -17,6 +17,8 @@ martor
 markdown
 django-filter
 django-q
+django-storages[s3]
+boto3
 
 redis