Configuration

La page de livraison

Le bucket se règle avec les variables que @colis/core lit déjà ; tout le reste est facultatif.

Une durée par défaut plus longue que DROP_MAX_EXPIRES_IN est ramenée à ce maximum. Le formulaire propose dix minutes, une heure, 6 h, 12 h, un jour, trois jours, sept jours, quatorze jours et trente jours, dans la limite du maximum (celui de la formule de l’expéditeur), plus la durée par défaut.

templates/drop/.env.example reprend chaque variable avec un commentaire, et un bloc pour MinIO.

Le mode ouvert

Sans DROP_PASSWORD, n’importe qui peut envoyer : le déploiement devient un service public, et trois plafonds protègent le bucket et sa facture. Avec un mot de passe, aucun ne s’applique.

• Envois par adresse : DROP_UPLOADS_PER_HOUR (20) par heure d’horloge, comptés sur POST /api/transfers et au début d’un envoi en morceaux, un par fichier. Le suivant répond 429 RATE_LIMITED, avec retry-after et un message qui dit dans combien de minutes réessayer.
• Taille : DROP_OPEN_MAX_UPLOAD_MB (100). Un fichier plus gros est refusé en 413 TOO_LARGE avant l’envoi.
• Durée de vie : DROP_OPEN_MAX_EXPIRES_IN (86 400 secondes, un jour). Le formulaire ne propose rien de plus long.

Ce sont les limites de la formule gratuite. Un compte sur la formule Pro a les siennes, DROP_PRO_MAX_UPLOAD_MB, DROP_PRO_MAX_EXPIRES_IN et DROP_PRO_UPLOADS_PER_HOUR, qui ne descendent jamais sous celles de la formule gratuite. Quand le déploiement vend Pro, un envoi gratuit qui dépasse la taille ou la durée, mais que Pro accepterait, est refusé en 403 PLAN_LIMIT plutôt qu’en 413 ou ramené en silence.

La page d’envoi affiche ces limites sous la zone de dépôt. Le compteur vit dans le bucket, sans base de données : un petit objet par adresse et par heure sous meta/uploads/, mis à jour par écriture conditionnelle, pour que toutes les instances voient le même. L’adresse est la première entrée de x-forwarded-for (ou x-real-ip), écrite par Vercel ; elle n’est jamais stockée, seulement son HMAC.

La CLI

Le fichier

colis.config.json, .colisrc.json ou .colisrc, cherché en remontant depuis le dossier courant, puis ~/.config/colis/config.json (ou $XDG_CONFIG_HOME/colis/config.json). --config ou $COLIS_CONFIG désignent un fichier précis, qui doit exister. Le premier fichier trouvé l’emporte : deux fichiers ne sont jamais fusionnés.

Toute autre clé est refusée, avec la clé la plus proche en suggestion. ${VAR} dans une chaîne est lu dans l’environnement ; une variable manquante est signalée par son nom avant toute requête. Un profil remplace la racine clé par clé, credentials comptant pour une seule clé.

Qui l’emporte

Une option l’emporte sur une variable d’environnement, qui l’emporte sur le fichier. colis config affiche la source de chaque valeur.

Quand rien ne nomme ni serveur (remote) ni bucket, la CLI envoie vers le service public, https://colis-tau.vercel.app/api/transfers, sans jeton ; colis config l’indique par default (public service). Un bucket configuré garde le mode direct, et remote l’emporte sur tout.

Les clés n’ont pas d’option, exprès : un secret passé en argument se retrouve dans ps et dans l’historique du shell.

La bibliothèque

createBucket() de @colis/core :

import { createBucket } from '@colis/core'

const store = createBucket({
  bucket: 'livraisons', // ou COLIS_BUCKET / S3_BUCKET
  region: 'eu-west-3', // ou COLIS_REGION / AWS_REGION / AWS_DEFAULT_REGION
  credentials: { accessKeyId: '…', secretAccessKey: '…' }, // à omettre pour la chaîne d’AWS
  endpoint: 'https://…', // ou COLIS_ENDPOINT / S3_ENDPOINT
  forcePathStyle: true, // vrai par défaut quand endpoint est défini
  publicUrl: 'https://cdn…', // ou COLIS_PUBLIC_URL / S3_PUBLIC_URL
  prefix: 'drop', // appliqué à l’entrée et retiré à la sortie
  maxSize: 4 * 1024 * 1024, // refuse un corps plus gros avant tout appel réseau
  syncCode: { length: 8 }, // la forme des codes, voir plus bas
  client: myS3Client, // votre propre S3Client
})

Le préfixe est un espace de noms, pas une partie de la clé : store.put('K7QP2M4X', …) écrit drop/K7QP2M4X et renvoie key: 'K7QP2M4X', path: 'drop/K7QP2M4X'.

La forme des codes

Par défaut, huit caractères en base32 de Crockford : 0123456789ABCDEFGHJKMNPQRSTVWXYZ, sans I, L, O ni U. Les trois premiers se confondent à la lecture ; retirer le quatrième évite qu’un code aléatoire forme un mot malheureux. Huit caractères de cinq bits font 40 bits.

import { createBucket, syncCodeAlphabets } from '@colis/core'

const store = createBucket({
  bucket: 'livraisons',
  syncCode: { length: 10, alphabet: syncCodeAlphabets.crockford },
})

store.codes.create() // "K7QP2M4XA9"
store.codes.entropyBits // 50

syncCodeAlphabets fournit aussi digits (0123456789) et alphanumeric (A à Z et 0 à 9). Un code plus court se dicte mieux mais se devine plus vite : il ne se justifie qu’avec une durée de vie courte et une limite sur les recherches. La page de livraison utilise la forme par défaut.