From 15c890b4cfaeea9793d8c2f8015a4a5bed3f348b Mon Sep 17 00:00:00 2001
From: boyska <piuttosto@logorroici.org>
Date: Fri, 29 Nov 2024 10:54:55 +0100
Subject: [PATCH] readme

---
 README.md | 75 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 75 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d1d5c11
--- /dev/null
+++ b/README.md
@@ -0,0 +1,75 @@
+caricari
+=============
+
+
+Dev howto
+------------
+
+```sh
+python3 -m venv
+. venv/bin/activate
+pip install -r requirements.txt
+flask dev --port 8000 caricari/private.py
+flask dev --port 8001 caricari/public.py
+```
+
+
+General Idea
+--------------
+
+un coso per caricare file su uno o più archivi
+
+per praticità nell'implementazione del login, ci sono due servizi separati: media.ondarossa.info e upload.ondarossa.info
+
+
+### upload.ondarossa.info
+
+(this is `public.py`)
+
+è l'interfaccia solo per utenti loggati (sito saml blabla)
+
+puoi caricare file manualmente
+oppure li può pescare da techrec (come modularizzare?)
+per ogni file si può mettere nella clipboard l'indirizzo pubblico, che è un url di media.ondarossa.info
+importantissimo: non fare niente che possa far credere che un link di upload.ondarossa.info sia il link corretto
+
+### media.ondarossa.info
+
+aka `public.py`
+
+sulla home non c'è niente
+
+su /dl/2024/11/15/ror-241115-tizio.ogg fa:
+* se i file sono stati caricati su archivio (e se l'archivio è vivo), fa redirect
+	* se ci sono più archivi che hanno il file, li elenca tutti nel campo Link, ma comunque manda sempre al primo archivio tra quelli vivi
+* altrimenti serve i file direttamente (se possibile)
+
+XXX: dovrebbe gestire le questione dei file convertiti (in base ad esempio agli Accept, o ad un parametro di query adhoc)? oppure no? come farlo? un metodo può essere fare verso archive è come se ci fossero più versioni archiviate, con formati diversi.
+
+sito
+sul sito si mette l'url che punta a media.ondarossa.info
+
+il tema deve "espandere" gli url in tutte le source che può in maniera automatica, ovvero:
+
+* media.ondarossa.info/dl/2024/11/a.ogg?format=ogg
+* media.ondarossa.info/dl/2024/11/a.ogg?format=mp3
+* www.arkiwi.org/blabla/a.ogg
+(ovvero con `?format` puoi dare priorità agli archivi che hanno quel formato; omettendolo, viene rispettato il campo Accept)
+
+... purtroppo per archive non ci sono modi automatici particolarmente sicuri.
+in questo modo se media.ondarossa.info va giù, c'è ancora archive funzionante. questo però non funziona per tutte le cose (ad esempio non per apple, né per i podcast).
+
+### Roadmap
+
+#### 1.0
+
+La versione minima per aver qualcosa di usabile deve fare almeno questo:
+
+* deve essere possibile l'upload da browser
+* carichi su archive.org
+* permetta lo scaricamento di file
+* gestisca `?format=mp3`, alla peggio facendo replace(ogg,mp3) da archive
+
+non è necessario che:
+* peschi da techrec in modo diretto
+* carichi su arkiwi