hcengineering/platform
1
0
Fork 0
mirror of https://github.com/hcengineering/platform.git synced 2024-11-23 05:53:09 +03:00
Code Issues Actions 4 Packages Projects Releases Wiki Activity
524c5b4ab8
platform/server/front/readme.md
Andrey Sobolev 863e9032cf
UBERF-7126: Content type based storage configuration (#5781) 
Signed-off-by: Andrey Sobolev <haiodo@gmail.com>
2024-06-17 13:56:57 +07:00

2.7 KiB
Raw Blame History

Overview

Front service is suited to deliver application bundles and resource assets, it also work as resize/recode service for previews, perform blob storage front operations.

Configuration

  • SERVER_PORT: Specifies the port number on which the server will listen.
  • MONGO_URL: Specifies the URL of the MongoDB database.
  • ELASTIC_URL: Specifies the URL of the Elasticsearch service.
  • ACCOUNTS_URL: Specifies the URL of the accounts service.
  • UPLOAD_URL: Specifies the URL for uploading files.
  • GMAIL_URL: Specifies the URL of the Gmail service.
  • CALENDAR_URL: Specifies the URL of the calendar service.
  • TELEGRAM_URL: Specifies the URL of the Telegram service.
  • REKONI_URL: Specifies the URL of the Rekoni service.
  • COLLABORATOR_URL: Specifies the URL of the collaborator service.
  • COLLABORATOR_API_URL: Specifies the URL of the collaborator API.
  • MODEL_VERSION: Specifies the required model version.
  • SERVER_SECRET: Specifies the server secret.
  • PREVIEW_CONFIG: Specifies the preview configuration.
  • BRANDING_URL: Specifies the URL of the branding service.

Preview service configuration

PREVIEW_CONFIG env variable format.

A ; separated list of triples, providerName|previewUrl|supportedFormats.

  • providerName - a provider name should be same as in Storage configuration. It coult be empty and it will match by content types.
  • previewUrl - an Url with :workspace, :blobId, :downloadFile, :size, :format placeholders, they will be replaced in UI with an appropriate blob values.
  • supportedFormats - a , separated list of file extensions.
  • contentTypes - a ',' separated list of content type patterns.

PREVIEW_CONFIG=*|https://front.hc.engineering/files/:workspace/api/preview/?format=:format&width=:size&image=:downloadFile

Variables

  • :workspace - a current workspacw public url name segment.
  • :blobId - an uniq blob _id identifier.
  • :size - a numeric value to determine required size of the image, image will not be upscaled, only downscaled. If -1 is passed, original image size value will be used.
  • :downloadFile - an URI encoded component value of full download URI, could be presigned uri to S3 storage.
  • :format - an a conversion file format, avif,webp etc.

Passing default variant.

providerName could be set to * in this case it will be default preview provider.

Default variant.

If no preview config are specified, a default one targating a front service preview/resize functionality will be used.

/files/${getCurrentWorkspaceUrl()}?file=:blobId.:format&size=:size

Testing with dev-production/etc.

Only a downloadFile variant of URIs will work, since app is hosted on localhost and token should be valid to use preview on production environment.