Skip to content
Snippets Groups Projects

Fix some typo + add doc for mail and media library service

Merged Fix some typo + add doc for mail and media library service
services-documentation into master
2 unresolved threads
Merged Ghost User requested to merge services-documentation into master
2 unresolved threads

Merge request reports

Merged by avatar (Mar 30, 2025 5:39pm UTC)

Loading

Pipeline #1029 passed

Stage: build
Stage: deploy

Pipeline passed for 7932a042 on master

Activity

Filter activity
  • Approvals
  • Assignees & reviewers
  • Comments (from bots)
  • Comments (from users)
  • Commits & branches
  • Edits
  • Labels
  • Lock status
  • Mentions
  • Merge request status
  • Tracking
docs/architecture/services/media-library.md
1 # Media library service
2
3 ## What it does
4
5 This service allows to upload a file in the configured bucket of a defined instance of [Minio](https://min.io/) (compatible with S3).
  • Ghost User
    Ghost User @ghost ·
    Author Contributor

    (you specify the bucket destination in the configuration of the service)

    By Nicolas Castejon on 2019-06-12T15:04:27 (imported from GitLab project)

  • Please register or sign in to reply
  • Ghost User
    Ghost User @ghost started a thread on an old version of the diff
    • docs/architecture/services/media-library.md
    2
    3 ## What it does
    4
    5 This service allows to upload a file in the configured bucket of a defined instance of [Minio](https://min.io/) (compatible with S3).
    6
    7 ## How it works
    8
    9 ![media-library-service](../../assets/media-library-service.png)
    10
    11 The entrypoint of the service is a REST API provided by a [NestJS](https://github.com/nestjs/nest) application. The service uses the [Javascript MinIO SDK](https://docs.min.io/docs/javascript-client-quickstart-guide.html) to interact with a running instance of Minio.
    12
    13 Before uploading the file, it makes sure that the specified bucket is created. If it is not the case, it creates it with a `public read access`.
    14
    15 The files are classified in sub-buckets as following `/<specified-bucket-name>/<year-YYYY>/<month-MM>/`.
    16
    17 The uploaded files keep there original name but are prefixed by an md5 computed based on their content with gives the following pattern for file names: `<md5>-<original-name>`. This means that if we upload twice the exact same picture, with the same name there will be only on file stored in MinIO.
    • Ghost User
      Ghost User @ghost ·
      Author Contributor

      Maybe define explicitly which file is kept when one file is uploaded with the same name

      By Nicolas Castejon on 2019-06-12T15:10:23 (imported from GitLab project)

    • Please register or sign in to reply
  • Ghost User
    Ghost User @ghost started a thread on an old version of the diff
    • docs/architecture/services/media-library.md
    1 # Media library service
    2
    3 ## What it does
    4
    5 This service allows to upload a file in the configured bucket of a defined instance of [Minio](https://min.io/) (compatible with S3).
  • Ghost User
    Ghost User @ghost started a thread on an old version of the diff
    • docs/architecture/services/media-library.md
    2
    3 ## What it does
    4
    5 This service allows to upload a file in the configured bucket of a defined instance of [Minio](https://min.io/) (compatible with S3).
    6
    7 ## How it works
    8
    9 ![media-library-service](../../assets/media-library-service.png)
    10
    11 The entrypoint of the service is a REST API provided by a [NestJS](https://github.com/nestjs/nest) application. The service uses the [Javascript MinIO SDK](https://docs.min.io/docs/javascript-client-quickstart-guide.html) to interact with a running instance of Minio.
    12
    13 Before uploading the file, it makes sure that the specified bucket is created. If it is not the case, it creates it with a `public read access`.
    14
    15 The files are classified in sub-buckets as following `/<specified-bucket-name>/<year-YYYY>/<month-MM>/`.
    16
    17 The uploaded files keep there original name but are prefixed by an md5 computed based on their content with gives the following pattern for file names: `<md5>-<original-name>`. This means that if we upload twice the exact same picture, with the same name there will be only on file stored in MinIO.
  • Ghost User added 1 commit

    added 1 commit

    • 7482c05d - Rephrase some sentences and fix typos

    Compare with previous version

    By Fabien Forestier on 2019-06-12T15:26:29 (imported from GitLab project)

  • Ghost User merged

    merged

    By Nicolas Castejon on 2019-06-13T07:47:56 (imported from GitLab project)

  • Ghost User mentioned in commit 7932a042

    mentioned in commit 7932a042

    By Nicolas Castejon on 2019-06-13T07:47:57 (imported from GitLab project)

    • Please register or sign in to reply