Skip to content

configuration

Axel Schwab edited this page Mar 18, 2024 · 10 revisions

under_construction.png

Configuration

More Information

Environment Variables

required

  • WINSLOW_WORK_DIRECTORY Absolut path to the working directory that has to be on a nfs

    • Value
      • default: /winslow/
        • Example /winslow/workdirectory/that/is/on/nfs
  • WINSLOW_STORAGE_TYPE defines the storage type

    • Values
      • bind default used for local storage
      • nfs network file storage

optional

Authentication
  • WINSLOW_LDAP_URL Connection string of LDAP Server

    • Values
      • Example: LDAP://server.ldap.domain.com
  • WINSLOW_AUTH_METHOD specifies the authentication backend for user management

    • Values
      • ldap use ldap for user authentication
      • local use winslow build in user management
  • WINSLOW_ROOT_USERS users with root access

    • Values
      • empty list Default
      • Example: luke,yoda,ahsoka
  • WINSLOW_ROOT_USERS a list of users splited by ,

General

  • WINSLOW_LOCK_DURATION_MS lock something don't know what TODO

    • Values
      • default: 300000 = 5min
      • minimum: 10s
  • WINSLOW_BACKEND defines the OCI backend, currently only Docker is supported

    • Values
      • docker use docker as OCI backend
  • WINSLOW_NO_STAGE_EXECUTION stage execution, act as observer / web-accessor

    • Values
      • default: 0 enable stage execution, act as observer / web-accessor
      • 1 disables stage execution
  • WINSLOW_NODE_NAME name of host system

    • Values
      • default: /etc/hostname
Development
  • WINSLOW_DEV_ENV disables authentication and allows access to all resources

    • Values
      • default: false, disables development mode
      • true enables development mode
  • WINSLOW_DEV_REMOTE_USER username to assign to requests

    • Values *
  • WINSLOW_DEV_ENV_IP publicly visible IP of the WEB-UI

    • Values
      • Example: 192.168.1.178
  • WINSLOW_DEV_ENV_IP: defines for development? TODO

    • Values
      • Example: 10.20.30.40
Web Configuration
  • WINSLOW_NO_WEB_API REST/WebSocket-API (no longer starts Spring Boot)

    • Values
      • default: 0 enables web api
      • 1 disable
  • WINSLOW_API_PATH defines the root uri for the backend server

    • Values
      • default: /api/v1/
  • WINSLOW_WEBSOCKET_PATH

    • Values
      • default: /ws/v1/
  • WINSLOW_STATIC_HTML path of static html page

    • Values
      • Example: /path/to/static/html/page
  • WINSLOW_WEB_REQUIRE_SECURE: activates usage of TLS certificate? TODO

    • Values
      • default: 0 disabled, no cert used
      • 1 enables usage of cert
Nvidia GPU (optional)
  • WINSLOW_NO_GPU_USAGE access to GPUs
    • Values * 0 disables * 1 enables

Clone this wiki locally