Frontend configuration

Download the example configuration file

The file contains environment settings that are loaded into the user's browser: the addresses of the backend, the storage and the WebSocket server.

Required mount

The file must be mounted into the container at /usr/share/nginx/html/app/assets/config.js.

Configuration structure

window.__RUNTIME_CONFIG__ = {
  API_URL: 'https://example.flip-chart.ru/app/api/v1',
  S3_URL: 'https://example.flip-chart.ru/app/s3/flip',
  WEBSOCKET_URL: 'wss://example.flip-chart.ru/app',
  ON_PREMISE: true,
  FEATURES: ['onPremiseLeftKeyMonth', 'onPremiseLeftKeyWeek'],
  KNOWLEDGE_BASE_URL: 'https://flip-chart.ru/knowledge-base',
  FAQ_URL: 'https://flip-chart.ru/faq',
};

Configuration fields

All fields are required.

• API_URL: Base URL of the backend API.
  Example: https://example.flip-chart.ru/app/api/v1
• S3_URL: Public URL of the S3 storage bucket (through the nginx proxy, path /app/s3/<bucket name>).
  Example: https://example.flip-chart.ru/app/s3/flip
• WEBSOCKET_URL: WebSocket connection URL.
  Example: wss://example.flip-chart.ru/app
• ON_PREMISE: On-premise mode. Value: true.
• FEATURES: List of enabled interface features. Value for on-premise (license key expiration notifications):
  ['onPremiseLeftKeyMonth', 'onPremiseLeftKeyWeek']
• KNOWLEDGE_BASE_URL: Link to the knowledge base in the help menu. You can point it to an internal resource.
  Example: https://flip-chart.ru/knowledge-base
• FAQ_URL: Link to the FAQ in the help menu. You can point it to an internal resource.
  Example: https://flip-chart.ru/faq