Skip to content

Commit 8b6247e

Browse files
MatlavvMatlavv
committed
update readme
1 parent 73cc76c commit 8b6247e

File tree

1 file changed

+47
-72
lines changed

1 file changed

+47
-72
lines changed

‎README.md

Lines changed: 47 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,8 @@ structure:
101101
"original_mimetype": "image/webp",
102102
"mimetype": "image/webp",
103103
"signature": "ca71754acda70e41cb23e465fbb5ecc683186cf779a2bae2cbf290527b1f6671",
104-
"size": 16730
104+
"size": 16730,
105+
"destination": "DEV"
105106
},
106107
{
107108
"uuid": "d26a191f-1087-4169-b6cd-3db96f38ece4",
@@ -126,10 +127,11 @@ structure:
126127

127128
### Daily jobs
128129

129-
2 daily jobs associated with TADA (Transform And Deliver Assets 🎉):
130+
3 daily jobs associated with TADA (Transform And Deliver Assets 🎉):
130131

131132
- a job to synchronize the state of our API in relation to YOUR delegated_storage: if the image is in the catalog, but not in your storage, it deletes the image from the catalog.
132133
- a catalog publication job on your delegated storage: the status of the catalog once a day is published on your storage which allows you to retrieve the most up-to-date list in the event of a new API instance.
134+
- a job to check the expiration of the files in the catalog with an expiration date.
133135

134136
## How to use TADA ? 🎉
135137

@@ -168,47 +170,47 @@ transform-and-deliver-assets:
168170
# SEE BELOW ALL VALUES
169171
```
170172

171-
| Clé | Description | Exemples de Valeurs |
172-
| ------------------------------------------------ | --------------------------------------------------- | ------------------------- |
173-
| local | Activer ou désactiver le mode local | true / false |
174-
| redis.service | Nom du service Redis | 'redis-service' |
175-
| redis.dumpFolderPath | Chemin du dossier de dump pour Redis | '/dumps' |
176-
| redis.storage.storageClassName | Nom de la classe de stockage pour Redis | 'hostpath' |
177-
| redis.storage.resources.requests.storage | Espace de stockage demandé par Redis | '500Mi' |
178-
| delegatedStorage.rateLimitWindow | Fenêtre de limitation de débit (ms) | 30000 |
179-
| delegatedStorage.rateLimit | Limitation de débit | 5 |
180-
| delegatedStorage.host | Nom d'hôte du service personnalisé | 'your_custom_service_api' |
181-
| delegatedStorage.routes.readinessCheck | Chemin de vérification de disponibilité | '/readiness-check' |
182-
| delegatedStorage.accessToken | Jeton d'accès pour le stockage délégué | 'your_access_token' |
183-
| delegatedStorage.storageMethod | Méthode de stockage | 'DISTANT_BACKEND' |
184-
| s3.routes.readinessCheck | Chemin de vérification de disponibilité pour MinIO | '/minio/health/live' |
185-
| s3.endpoint | Point de terminaison (endpoint) pour S3/MinIO | 'minio' |
186-
| s3.port | Port pour S3/MinIO | '9000' |
187-
| s3.accessKey | Clé d'accès pour S3/MinIO | 'minioadmin' |
188-
| s3.secretKey | Clé secrète pour S3/MinIO | 'minioadmin' |
189-
| s3.bucketName | Nom du bucket S3/MinIO | 'media' |
190-
| s3.storage.storageClassName | Nom de la classe de stockage pour S3/MinIO | 'hostpath' |
191-
| s3.storage.resources.requests.storage | Espace de stockage demandé pour S3/MinIO | '500Mi' |
192-
| mediaApi.service | URL du service média | 'http://media-service' |
193-
| mediaApi.apiPrefix | Préfixe de l'API pour le service média | '/palpatine' |
194-
| mediaApi.routes.healthcheck.get | Chemin de vérification de la santé du service média | '/readiness-check' |
195-
| mediaApi.routes.file.get | Chemin GET pour récupérer des fichiers | '/assets/media/' |
196-
| mediaApi.routes.file.post | Chemin POST pour télécharger un fichier | '/upload' |
197-
| mediaApi.routes.files.post | Chemin POST pour télécharger plusieurs fichiers | '/uploads' |
198-
| mediaApi.routes.catalog.get | Chemin GET pour récupérer le catalogue de fichiers | '/catalog' |
199-
| mediaApi.payloadMaxSize | Taille maximale de la charge utile | '10mb' |
200-
| mediaApi.rateLimit.windowMs | Fenêtre de limitation de débit (ms) | 30000 |
201-
| mediaApi.rateLimit.limit | Limitation de débit | 5 |
202-
| mediaApi.originsAllowed | Origines autorisées | 'localhost,\*' |
203-
| mediaApi.methodsAllowed | Méthodes HTTP autorisées | 'GET,POST' |
204-
| mediaApi.storage.storageClassName | Nom de la classe de stockage pour le provider média | 'hostpath' |
205-
| mediaApi.storage.resources.requests.storage | Espace de stockage demandé pour le media provider | '500Mi' |
206-
| rateLimit.windowMs | Fenêtre de limitation de débit (ms) | 30000 |
207-
| rateLimit.limit | Limitation de débit | 5 |
208-
| domain | Domaine du service | '.media' |
209-
| env | Environnement du service | 'media-service' |
210-
| NAMESPACES_ALLOWED | Espaces de noms autorisés | 'DEV' |
211-
| version | Version du chart | '1.0.6' |
173+
| Clé | Description | Exemples de Valeurs |
174+
| ------------------------------------------- | ------------------------------------------ | ------------------------- |
175+
| local | Enable or disable the local mode | true / false |
176+
| redis.service | Redis service name | 'redis-service' |
177+
| redis.dumpFolderPath | Redis dump folder path | '/dumps' |
178+
| redis.storage.storageClassName | Redis storage class name | 'hostpath' |
179+
| redis.storage.resources.requests.storage | Redis storage requested space | '500Mi' |
180+
| delegatedStorage.rateLimitWindow | Delegated storage rate limit window (ms) | 30000 |
181+
| delegatedStorage.rateLimit | Delegated storage rate limit | 5 |
182+
| delegatedStorage.host | Custom service API host | 'your_custom_service_api' |
183+
| delegatedStorage.routes.readinessCheck | Readiness check path | '/readiness-check' |
184+
| delegatedStorage.accessToken | Access token for the delegated storage | 'your_access_token' |
185+
| delegatedStorage.storageMethod | Storage method | 'DISTANT_BACKEND' |
186+
| s3.routes.readinessCheck | Readiness check path for MinIO | '/minio/health/live' |
187+
| s3.endpoint | Endpoint for S3/MinIO | 'minio' |
188+
| s3.port | Port for S3/MinIO | '9000' |
189+
| s3.accessKey | Access key for S3/MinIO | 'minioadmin' |
190+
| s3.secretKey | Secret key for S3/MinIO | 'minioadmin' |
191+
| s3.bucketName | Bucket name for S3/MinIO | 'media' |
192+
| s3.storage.storageClassName | Storage class name for S3/MinIO | 'hostpath' |
193+
| s3.storage.resources.requests.storage | Requested storage space for S3/MinIO | '500Mi' |
194+
| mediaApi.service | URL for the media service | 'http://media-service' |
195+
| mediaApi.apiPrefix | API prefix for the media service | '/palpatine' |
196+
| mediaApi.routes.healthcheck.get | Media healthcheck endpoint | '/readiness-check' |
197+
| mediaApi.routes.file.get | Endpoint to get files | '/assets/media/' |
198+
| mediaApi.routes.file.post | Endpoint to upload a file | '/upload' |
199+
| mediaApi.routes.files.post | Endpoint to upload multiple files | '/uploads' |
200+
| mediaApi.routes.catalog.get | Endpoint to get the file catalog | '/catalog' |
201+
| mediaApi.payloadMaxSize | Maximum payload size | '10mb' |
202+
| mediaApi.rateLimit.windowMs | Rate limit window (ms) | 30000 |
203+
| mediaApi.rateLimit.limit | Rate limit | 5 |
204+
| mediaApi.originsAllowed | Allowed origins | 'localhost,\*' |
205+
| mediaApi.methodsAllowed | Allowed HTTP methods | 'GET,POST' |
206+
| mediaApi.storage.storageClassName | Storage class name for media provider | 'hostpath' |
207+
| mediaApi.storage.resources.requests.storage | Requested storage space for media provider | '500Mi' |
208+
| rateLimit.windowMs | Rate limit window (ms) | 30000 |
209+
| rateLimit.limit | Rate limit | 5 |
210+
| domain | Domain for the service | '.media' |
211+
| env | Environment for the service | 'media-service' |
212+
| NAMESPACES_ALLOWED | Allowed namespaces | 'DEV' |
213+
| version | Chart version | '1.0.6' |
212214

213215
### Using docker image API :
214216

@@ -299,16 +301,6 @@ Prerequisites:
299301

300302
<p align="right">(<a href="#readme-top">back to top</a>)</p>
301303

302-
<!-- USAGE EXAMPLES -->
303-
304-
## Usage
305-
306-
Use this space to show useful examples of how a project can be used.
307-
308-
_For more examples, please refer to the [Documentation](https://example.com)_
309-
310-
<p align="right">(<a href="#readme-top">back to top</a>)</p>
311-
312304
<!-- ROADMAP -->
313305

314306
## Roadmap
@@ -350,25 +342,8 @@ Distributed under the MIT License. See `LICENSE.txt` for more information.
350342
351343
## Contact
352344
353-
Maintainer name - email@example.com
354-
355-
Project Link: [https://github.com/](https://github.com/)
356-
357-
<p align="right">(<a href="#readme-top">back to top</a>)</p>
358-
359-
<!-- ACKNOWLEDGMENTS -->
360-
361-
## Acknowledgments
362-
363-
Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!
345+
Maintainer name - Bouygues Telecom
364346
365-
- [Choose an Open Source License](https://choosealicense.com)
366-
- [GitHub Emoji Cheat Sheet](https://www.webpagefx.com/tools/emoji-cheat-sheet)
367-
- [Malven's Flexbox Cheatsheet](https://flexbox.malven.co/)
368-
- [Malven's Grid Cheatsheet](https://grid.malven.co/)
369-
- [Img Shields](https://shields.io)
370-
- [GitHub Pages](https://pages.github.com)
371-
- [Font Awesome](https://fontawesome.com)
372-
- [React Icons](https://react-icons.github.io/react-icons/search)
347+
Project Link: [https://github.com/](https://github.com/BouyguesTelecom/TADA)
373348
374349
<p align="right">(<a href="#readme-top">back to top</a>)</p>

0 commit comments

Comments
 (0)