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

    • Default
      • /winslow/
    • Example:
      • nfs-host:/path/to/nfs
  • WINSLOW_STORAGE_TYPE defines the storage type

    • Default
      • bind used for local storage
    • Other
      • nfs network file storage

optional

Authentication
  • WINSLOW_LDAP_URL Connection string of LDAP Server

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

    • Default
      • null
    • Other
      • ldap use ldap for user authentication
      • local use winslow build in user management
  • WINSLOW_ROOT_USERS a list of users split by ,

    • Default
      • empty list
    • Example:
      • luke,yoda,ahsoka
      • luke

General

  • WINSLOW_LOCK_DURATION_MS lock something don't know what TODO

    • Default
      • 300000 = 5min, minimum allowed value is 10000ms = 10s
    • Example
      • 15000
  • WINSLOW_BACKEND defines the OCI backend, currently only Docker is supported

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

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

    • Default
      • content of /etc/hostname
    • Example
      • winslow1
Development
  • WINSLOW_DEV_ENV disables authentication and allows access to all resources

    • Default
      • false disables development mode
    • Other
      • true enables development mode
  • WINSLOW_DEV_REMOTE_USER username to assign to requests

    • Default
      • null
    • Example
      • lea
  • WINSLOW_DEV_ENV_IP publicly visible IP of the WEB-UI

    • Default
      • null
    • Example
      • 192.168.1.178
Web Configuration
  • WINSLOW_NO_WEB_API REST/WebSocket-API (no longer starts Spring Boot)

    • Default
      • 0 enables web api
    • Other
      • 1 disable
  • WINSLOW_API_PATH defines the root uri for the backend server

    • Default
      • /api/v1/
  • WINSLOW_WEBSOCKET_PATH

    • Default
      • /ws/v1/
  • WINSLOW_STATIC_HTML path of static html page

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

    • Default
      • 0 disabled, no cert used
    • Other
      • 1 enables usage of cert
Nvidia GPU (optional)
  • WINSLOW_NO_GPU_USAGE access to GPUs
    • Default
      • 0 disables
    • Other
      • 1 enables

Clone this wiki locally