Sign inSign up

ravbaski/epa_app

By ravbaski

•Updated about 2 years ago

Easily automate development documentation for every issue in Easy Project software.

Image
Integration & delivery
0

248

ravbaski/epa_app repository overview

⁠Setup EPA application

To set up this application correctly, please follow the steps below:

1. Download EPA_APP image from Docker Hub. Run: docker push ravbaski/epa_app:latest

2. Create epa folder (app folder)

  • Linux platform: Create epa folder in /var/www/ or /opt as app folder.

  • Windows platform: Create epa folder on C:\ drive as app folder.

3. Create Docker_compose.yml file in app folder Docker_compose.yml file:

 services:
      epa_service:
        image: epa_app  #Replace image name if epa_app image is renamed
        container_name: epa_service  #Replace with your name of container (app) in docker
        ports:
          - "6000:8000"  # Map desired host port to container port 8000
        volumes:
          - ./config.yaml:/app/app/config.yaml # Map custom configuration file config.yaml to container. /app/app/config.yaml is default file
          - ./logs:/app/logs  # Mount local logs folder to container logs folder
          - ./your_folder/:/drive  # Mount (shared) folder where will epa_service create folders and documentation based settings in config.yaml
        environment:
          - APP_ENV=production  # Add any environment variables if necessary
        deploy:
          resources:
            limits:
              # cpus: '1.0'  # limit to 1 cpu
              memory: 100M  # limit RAM usage to 100MB
        restart: unless-stopped  # Automatically restart the container unless it is manually stopped

4. Create config.yaml file lin app folder Config.yaml (default) settings:

server:
  host: '0.0.0.0'  # The IP address to bind to
  port: 8000       # The port number to listen on
  threads: 4       # Number of threads to handle requests
security:
  api_keys: 
    - 'd9a8e7f6c1a3b4c5d6e7f8a9b0c1d2e3f4a5b6c7d8e9f0a1b2c3d4e5f3a7b8c9'
  # ip_whitelist:
    # - 'localhost'
    # - '0.0.0.0'
    # - '127.0.0.1'
# List of processed issue types with folder and documentation settings
issue_types:
  Razvojna naloga:
    base_dir: '/drive/razvojni projekti/'
    folders:
      - '{id}/FS'
      - '{id}/Razvoj'
      - '{id}/Tehnologija'
    word_doc_location: '/drive/razvojni projekti/{id}/FS' # Location of word document for issues
  Cenitve nepremičnin:
    base_dir: '/drive/cenitve/'
    folders:
      - '{id}'
logging:
  web_request:
    level: DEBUG  # Logging level for web requests (DEBUG, INFO, WARNING, ERROR, CRITICAL)
    filename: '/app/logs/web_requests.log'  # Log file path
    format: '%(asctime)s - %(name)s - %(levelname)s - %(message)s'  # Log format
    max_bytes: 102400  # Max size for log file (100 KB)
    backup_count: 3
  api:
    level: ERROR  # Logging level for API processing (DEBUG, INFO, WARNING, ERROR, CRITICAL)
    filename: '/app/logs/api_logs.log'
    format: '%(asctime)s - %(name)s - %(levelname)s - %(message)s'  # Log format
    max_bytes: 102400  # Max size for log file (100 KB)
    backup_count: 3

5. Create and run EPA container. Run: docker-compose.yml --build

If you want to store documents on file share mount shared disk to linux folder.

⁠App folder structure

   www/
    ├── epa           
    │   ├── logs/
    │   │   ├── app.log
    │   │   ├── web_request.log
    │   ├── your_folder/
    │   │   ├── razvojni projekti/    
    │   │   │   ├──  123/
    │   │   │   │   ├── FS/
    │   │   │   │   │   ├── 123.docx
    │   │   │   │   ├── Razvoj/
    │   │   │   │   ├── Tehnologija/
    │   │   ├── cenitve/
    │   │   │   ├──  124/        
    │   ├── config.yaml     
    │   ├── Docker-compos.yml

Tag summary

Content type

Image

Digest

sha256:5d8edffe9…

Size

55.3 MB

Last updated

about 2 years ago

docker pull ravbaski/epa_app