From b70ee7fd07c1bb5fc42441b555da6b4ef99a6b4e Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Daniel=20Omar=20Vergara=20P=C3=A9rez?=
 <daniel.omar.vergara@gmail.com>
Date: Tue, 10 Sep 2024 23:31:31 -0600
Subject: [PATCH 01/11] chore(main): Add graceful shutdown to the http service

---
 main.go | 97 +++++++++++++++++++++++++++++++++++++++++++++++++++------
 1 file changed, 87 insertions(+), 10 deletions(-)

diff --git a/main.go b/main.go
index ca7a23b..cbbcc9b 100644
--- a/main.go
+++ b/main.go
@@ -2,6 +2,7 @@ package main
 
 import (
 	"bytes"
+	"context"
 	"embed"
 	"errors"
 	"fmt"
@@ -10,8 +11,12 @@ import (
 	"log"
 	"net/http"
 	"os"
+	"os/signal"
 	"path/filepath"
 	"strings"
+	"sync"
+	"syscall"
+	"time"
 
 	"github.com/gabriel-vasile/mimetype"
 	"github.com/go-chi/chi/v5"
@@ -290,11 +295,16 @@ func handleFileFormat(w http.ResponseWriter, r *http.Request) error {
 	}
 
 	tmpl, err := template.ParseFS(templatesHTML, templates...)
-	if err = tmpl.ExecuteTemplate(w, "format-elements", f.SupportedFormats()); err != nil {
+	if err != nil {
 		log.Printf("error occurred parsing template files: %v", err)
 		return WithHTTPStatus(err, http.StatusInternalServerError)
 	}
 
+	if err = tmpl.ExecuteTemplate(w, "format-elements", f.SupportedFormats()); err != nil {
+		log.Printf("error occurred executing template files: %v", err)
+		return WithHTTPStatus(err, http.StatusInternalServerError)
+	}
+
 	return nil
 }
 
@@ -320,13 +330,7 @@ func handleModal(w http.ResponseWriter, r *http.Request) error {
 	return nil
 }
 
-func main() {
-	port := os.Getenv("MORPHOS_PORT")
-	// default port.
-	if port == "" {
-		port = "8080"
-	}
-
+func newRouter() http.Handler {
 	r := chi.NewRouter()
 	r.Use(middleware.Logger)
 
@@ -335,21 +339,90 @@ func main() {
 	var staticFS = http.FS(staticFiles)
 	fs := http.FileServer(staticFS)
 
+	addRoutes(r, fs, fsUpload)
+
+	return r
+}
+
+func addRoutes(r *chi.Mux, fs, fsUpload http.Handler) {
+	r.HandleFunc("/healthz", healthz)
 	r.Handle("/static/*", fs)
 	r.Handle("/files/*", http.StripPrefix("/files", fsUpload))
 	r.Get("/", toHandler(index))
 	r.Post("/upload", toHandler(handleUploadFile))
 	r.Post("/format", toHandler(handleFileFormat))
 	r.Get("/modal", toHandler(handleModal))
+}
+
+func run(ctx context.Context) error {
+	port := os.Getenv("MORPHOS_PORT")
+
+	// default port.
+	if port == "" {
+		port = "8080"
+	}
 
-	http.ListenAndServe(fmt.Sprintf(":%s", port), r)
+	ctx, stop := signal.NotifyContext(ctx,
+		os.Interrupt,
+		syscall.SIGTERM,
+		syscall.SIGQUIT)
+	defer stop()
+
+	r := newRouter()
+
+	srv := &http.Server{
+		Addr:    fmt.Sprintf(":%s", port),
+		Handler: r,
+	}
+
+	go func() {
+		if err := srv.ListenAndServe(); err != nil && err != http.ErrServerClosed {
+			fmt.Fprintf(os.Stderr, "error listening and serving: %s\n", err)
+		}
+	}()
+
+	var wg sync.WaitGroup
+	wg.Add(1)
+
+	go func() {
+		defer wg.Done()
+		<-ctx.Done()
+
+		log.Println("shutdown signal received")
+
+		ctxTimeout, cancel := context.WithTimeout(context.Background(), 10*time.Second)
+		defer cancel()
+
+		srv.SetKeepAlivesEnabled(false)
+
+		if err := srv.Shutdown(ctxTimeout); err != nil {
+			fmt.Fprintf(os.Stderr, "error shutting down http server: %s\n", err)
+		}
+
+		log.Println("shutdown completed")
+	}()
+
+	wg.Wait()
+
+	return nil
+}
+
+func main() {
+	ctx := context.Background()
+
+	if err := run(ctx); err != nil {
+		fmt.Fprintf(os.Stderr, "%s\n", err)
+		os.Exit(1)
+	}
+
+	log.Println("exiting...")
 }
 
 // renderError functions executes the error template.
 func renderError(w http.ResponseWriter, message string, statusCode int) {
 	w.WriteHeader(statusCode)
 	tmpl, _ := template.ParseFS(templatesHTML, "templates/partials/error.tmpl")
-	tmpl.ExecuteTemplate(w, "error", struct{ ErrorMessage string }{ErrorMessage: message})
+	_ = tmpl.ExecuteTemplate(w, "error", struct{ ErrorMessage string }{ErrorMessage: message})
 }
 
 func fileNameWithoutExtension(fileName string) string {
@@ -359,3 +432,7 @@ func fileNameWithoutExtension(fileName string) string {
 func filename(filename, extension string) string {
 	return fmt.Sprintf("%s.%s", fileNameWithoutExtension(filename), extension)
 }
+
+func healthz(w http.ResponseWriter, r *http.Request) {
+	w.WriteHeader(http.StatusOK)
+}

From 8ed4535a280f7afffe24be68e0232e6ffff78b39 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Daniel=20Omar=20Vergara=20P=C3=A9rez?=
 <daniel.omar.vergara@gmail.com>
Date: Thu, 12 Sep 2024 23:10:27 -0600
Subject: [PATCH 02/11] build(compose): add a health check to the compose file

---
 docker-compose.yml | 18 ++++++++++++------
 1 file changed, 12 insertions(+), 6 deletions(-)

diff --git a/docker-compose.yml b/docker-compose.yml
index 97a3338..822299a 100644
--- a/docker-compose.yml
+++ b/docker-compose.yml
@@ -1,8 +1,14 @@
 name: morphos
 services:
-    morphos-server:
-        ports:
-            - 8080:8080
-        volumes:
-            - /tmp:/tmp
-        image: ghcr.io/danvergara/morphos-server:latest
+  morphos-server:
+    image: ghcr.io/danvergara/morphos-server:latest
+    ports:
+      - 8080:8080
+    volumes:
+      - /tmp:/tmp
+    healthcheck:
+      test: timeout 10s bash -c ':> /dev/tcp/127.0.0.1/8080' || exit 1
+      interval: 60s
+      retries: 3
+      start_period: 20s
+      timeout: 30s

From c8d2a1922d64281a57ffe9c9ab35b983e88e9ce4 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Daniel=20Omar=20Vergara=20P=C3=A9rez?=
 <daniel.omar.vergara@gmail.com>
Date: Thu, 12 Sep 2024 23:12:32 -0600
Subject: [PATCH 03/11] build(main): rename the temporary path environment
 variable

---
 README.md | 7 +++++++
 main.go   | 2 +-
 2 files changed, 8 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index ed005ec..de3c26f 100644
--- a/README.md
+++ b/README.md
@@ -68,6 +68,13 @@ A modal will pop up with a preview of the converted image.
 
 <img src="screenshots/modal_morphos.png"/>
 
+### Configuration
+
+The configuration is only done by the environment varibles shown below.
+
+* `MORPHOS_PORT` changes the port the server will listen to (default is `8080`)
+* `MORPHOS_UPLOAD_PATH` defines the temporary path the files will be stored on disk (default is `/tmp`)
+
 ## Supported Files And Convert Matrix
 
 ### Images X Images
diff --git a/main.go b/main.go
index cbbcc9b..d4a9be0 100644
--- a/main.go
+++ b/main.go
@@ -44,7 +44,7 @@ var (
 )
 
 func init() {
-	uploadPath = os.Getenv("TMP_DIR")
+	uploadPath = os.Getenv("MORPHOS_UPLOAD_PATH")
 	if uploadPath == "" {
 		uploadPath = "/tmp"
 	}

From 26b0a180376f4165883f6e1e8179eaa028e8c5a7 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Daniel=20Omar=20Vergara=20P=C3=A9rez?=
 <daniel.omar.vergara@gmail.com>
Date: Thu, 12 Sep 2024 23:13:26 -0600
Subject: [PATCH 04/11] build(make): add changes to the makefile

---
 Makefile | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)

diff --git a/Makefile b/Makefile
index da73c54..a937470 100644
--- a/Makefile
+++ b/Makefile
@@ -1,7 +1,6 @@
 HTMX_VERSION=1.9.6
 RESPONSE_TARGETS_VERSION=1.9.11
 BOOTSTRAP_VERSION=5.3.2
-GO_VERSION=1.21.5
 
 .PHONY: run
 ## run: Runs the air command.
@@ -27,11 +26,11 @@ download-bootstrap:
 .PHONY: docker-build
 ## docker-build: Builds the container image
 docker-build:
-	docker build --build-arg="GO_VERSION=${GO_VERSION}" -t morphos .
+	docker build -t morphos .
 
 .PHONY: docker-run
 ## docker-run: Runs the container
-docker-run:
+docker-run: 
 	docker run --rm -p 8080:8080 -v /tmp:/tmp morphos
 
 .PHONY: help

From cc4217966028b3dec96834dc061002a20f21a9f4 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Daniel=20Omar=20Vergara=20P=C3=A9rez?=
 <daniel.omar.vergara@gmail.com>
Date: Thu, 12 Sep 2024 23:53:13 -0600
Subject: [PATCH 05/11] fix(templates): fix zip files preview

---
 static/zip-icon.png                  | Bin 0 -> 5142 bytes
 templates/partials/active_modal.tmpl |   2 +-
 2 files changed, 1 insertion(+), 1 deletion(-)
 create mode 100644 static/zip-icon.png

diff --git a/static/zip-icon.png b/static/zip-icon.png
new file mode 100644
index 0000000000000000000000000000000000000000..c137c25b0e945dd0c4dceefcdbeb4f5016f33b17
GIT binary patch
literal 5142
zcmeHLd0b8F*I&=sr*oQ4p+OVQRW6#7Bq|5pNK`1A)X|`*G^&(pbBPAZPzveXTuIU`
znvgm)QZ#6u9B#u&BaxCizrFAK|NHsezurII-}A@b>-j!web=+r-k-Iey<@B_b}&R0
zL;-+dw$o%E0EG}KAdC^WicFPS01T{lTmL2y2ngiA<G&gB|Cs?X<>C)S<bt4m7W)BF
zFscxZE-WG{CeDzMT(o$Jl(dZOQaO1AMWtoSS1^BBsjRZ<*VSv*s;a4LXliNetkYeu
zw?TiS!KTfIM#fuMTeodD`OS34PP1L+yZ2aFTJ7Dp-`eKDL0da}2ggHB&g{c3u5Ru}
zJUovc^YZpN?(63t5EyhKI3)CBSoo=k$SC~uncvTzi#~rLCN?hq;-!Sd%U7;mOG>_;
zl6vFjt+d<eoIf(|{CPL?Ue^8W2RRRO|H{jM^thm~sJP_G(`Tj6%gVVgURG3ARoB$M
zdR<rl=50e`Q}er)*0%PJ&aUpB-oE#|4<G;T9~d0s4}TgN9UGsR{QPC=>$mCeGqXSD
ze$Fq92zTlMNLHJfY_<068|x0gb@9Y<?q`p;^(B>w<~L~PY&Tq1Ikv0dH?x#i_GZ^b
z;-dd7^0|94dEb@p;Nqv3UuJY^B-I^>v3`0~)lIor&(kIPaJ|7)??R`OPJ{2@ts%n(
zgQ3}Z<Mi@|+4<XnWxhuSpV-PS{&ypFUx4ZPT!oh5Ak$&?%%Mylk=S3ymOH1%m|8PE
z&U>~>9+E#sbsvm5o+QrBIedNp${#jeX)mHXO`0CPoRaggWh~j#-Fo3e^wd<j$w7FO
zFZ=hyf@^OweAV{J`?(LqzI|SatKAPPYXdima&C!tQ|Z?Fl9z*g3C>s5XvZcQoYISS
z9^PD?qp3VN73vos@woKax|S3JHLn$cFdVBq{HZtDx$Q_}cGwMI9SGROvJqS@%YNQk
zdVEf2E_p}!*QL8qU`j#8h$W3TdnsH-*Is76IsJh^GNm@_4UM@yrLYrr{dJ_n6idvQ
zN-b&vw}#aCZcn%pqB>;(pzB=V8$Sg7&NgzPKT)WyJM<5z{Ca#noV*ZolfjB?sC`4T
z>iRuZk->`X(*0UVwR)VE5td6yH1g2-c9zO1RWj^31YczCVf8fTg#RY4H>^u|hmK&0
zX5xK>9RKPjgBi-WqpyG~mEoNP%|hKUJVv$cCsHD}p_1MH&t~#}>4QX@TM~KVrLvQ8
zP9K8sPUv4e=(_<Ij(iSyGMs6ra6KWQ1Opca>zg0{Q79xn-vjLWKvWd5pAJN9tu~0g
z9#Ye(a0k`8K?;KvfY=*wwid`SSeG1yNw_Z)v=wmgY%yF8c|Ht<tdowY_C_{nPug>}
z>=XYnl_pJ1fe7P|K2lq0SQwu{S?PDP%<5rhq%KsB?R1%U#C>j#kbC+PsYg1H{S}cD
zIUtgtO!~E2LBg?{N%+x(H#sS4!C3VpC1!gC9av&vEAT3MFlHQubg~;GB6gD|tQWne
z;Z5-8%t{Dtib&|tU*80^WrHxusXV30T?k@DkW6hh7@_3m4`krOpsk4aAR?t_b4mEm
z85dG#TAxl#`n!LCU%tm+x4!0KR7-C~ytq;d)BGQ&^;9y=7DT+vmZc=qom7}Cx-ll*
zYAy@`90M@axO`hI&u0}GlpW!PTSHt}W~vZRV-8W6`KWYA2RDYD-mu?@=4S*;6uAsi
z!*ntH6yrT|jg3BAUhM}nOK~*~GQez0NyK%7<P)zp3xT#g*HUjHX~1F&g*!S;o+SQf
zSPFu@PE@^dO+V!`uB`l6%MgQTly#$UlCLGnepez3+H}^?P^7wGXgd1YC&U$oZ-Z;!
zmh^wea0EXF9#}rrI0o<rwb<?Z>@yRAIC{9kh-$dpNC-5_v65bE^(>zd0UxBIB{Ae*
zstJuU+;@i$MQV66zz79NOi_Lw15XjAyK6}?Tbznt0@L#ml5fY?1E0>Ex0(q#Y$OWv
zP=A59q4aMCa1`;D`O7^Q3>4rg;>$Fpm81hpAEFXQokrWBQH*=PW+kRA4`E17>BBp@
z&4{xUA5xB3KC~M=g?Mp0ksHQZ4Xx(NLX%7gqWJBtOmHh>KpMnfkmDKypUOVaZ|Uv<
zEM+iXNpF+|1!OC4fWL)CVQzFSaukD$;C)evdyxbdYEeAkrf_M81X~@xBCFM3X6tqX
zALCraAP#XPaW5s95r!Wi_X)Vmi3Ro<4F0eNPmFhx4j+Sw=icM{L<+70OA+30M2#z;
z3)Tcsc#_a4#PV4^b$yr+xKA#DItAB+++Zr(2!fDy<zoC0x!|mXgfoF91q}ui=0(I2
z!9&tei5%R3nb-1oBs5Z4f9OI8Vo5^btvAk@q%gFRnzsnTfIq&7y9xM+owpr`G|}<T
z5{P;gafI-411gh23dLy@J{2^e-#}>60Xz|p{p6K#@bf+Ilfyebfe)M`vr%1k!GAe8
z_lZCdG``lsXQ2_X^lPAv!lFa*CfX#iU+^n;g}VqmfoE3({o;hcz8?t75C`EG-y%mk
zFhF`EU0W0u=vLcrVJQ?4V4m_q_(8;rf`cZA&48bhyyP|Djo||H(?Aqzt^zL{8cYzY
z84-f7DaOIzlq7G;6WkE@J49ZfamQeCGyZ7_1Aj#dvU^bq9m=s1Lsbya@b{=kNd}()
zUI@6}p;%p^LOK?zstU~j#`MVqJ`~XL26Rec8Quqz2Kb34#HSG|wo1$JHWFB!fmzWB
zRX=BIh&7NTXnxP2<jFuJy-`^e9v}kn=t6ucP5d6|qs^n~r=*_@xy93KKq;F7?=jD%
zLinsK0dc#=mAF7=CDRpZyf799KHDr%eIalVj0l~FT|^@yUcA^elyV#qQd`9(f`blw
zpv9O+<=To74?HhAt>FDFoeg6fhc`8@g+>~#=dg0D(Lk1bFWvW?os#@k0G!1zQZRNI
zmDEu11CUd6UO82uL|CJ|r%J+63scz?)@C^H_^+2rQJv5I=L3LebJRClPms|k3k6iR
z&~k?BLU)%fG)m*{C+4%Rd|q)fD_IC4kgeH#@d51xUQYZ>lmSuHTDrgAkDLvEXtVMZ
zF}=l2N|;y^^}XRyPjt-Z0bt4&rcb^Y=Lw3ndJ1^aT_RHic3_o95MOt+y3QeURoit8
zD#)*#|Eu95%HgQZJDxrbS!e$39zx$Yo#}O$GIn}CdU00E*vO}OK1#_Tw4+xlv%zU*
zdQLGU8F8iH<nZ{{A2D@KU6r}=(>05Fo=msCQVvTycrPR2da}XK`-SJgPmw#MIc6-V
zbidhA#y|aKZbG4BHs@Mih}p3lM&GrG`n70wL624@Ma5r0q-w-hQ%Di#KB7FKBlbF|
z+vJLf&cU`bDk7U=+uArF8n&9d4hi1XL`1jBX=x{$xZ1ZvL<i#@v!>!yNQ`7ULC$8B
z2+((>1npc92Y<S@^+!7QlN^P03$0fRP-L|R>sy8eyuC6ovgK6Bi^ox)>>s}zOQ*6<
zA!^%&I<QbP8cx2<cyjd9e1j^6yFz&N*+Yu0Z@*vYhUU8RJWo@NfgR3bP&XG&iE~)9
z;kd&RF<7}dJlpukPN)Q~a8;R2Sz-q)da~VL_#Pec4Db-^Ib(Gl%qsZmN4aE->jhif
z))c)Fuady86%}o{uoWg1SX-)c^@?_hqgv6qI~%27ITmVHIHJ2`Ke!0u*t-_NZA!;p
zhy0_GF*<Or@(@feVRiaShqv`gc>$eL<U0f4L`li)+JDj`*8}<~-TLZO{5*WgUR$KZ
z%%>;%%thaaNeS-f;Miq~vXzLHJEk~J#Y3PvD>#RDTzvuz*>lm|z>~+nW3i0DRm)+#
zD57E`gbH!8QeDbrcYLI<Ib({q0Y3;dwIcJ}NiD4jaD3s6bc80Ok3E}HF$RUsvcob^
ziW1+m^1Eki{>FIw=PG6upbz*DJ93WQuB3D4r)vTMZbQn$F7Mb%IxFw)*obb40$&6d
zWQ|upSC?K5mfb5XC7=`*JvGU<>Dmw@iJu9Zrhio>AZ@e4R&N4eJJ0<sGD^pZDz?XF
zw8i`*#$0dZ&sr)9J#;^7e?gi}l<z4}I`HQG4_z<>ZTrF|ml!eJW>3<Jd0i-xWV>H+
zNx!MG9E@L??Th^4jqnkO^v>zX{QRN=n>ij_BWfJVGba>T-=;PkJy!{=*LUr<kEi`;
zZr1aCJ3mt5#86$}VN}S)Y&l)-*D5J2l~ukZOK`i5cXRf}4<IfJB@9l^Gna&G2`Wuc
zU`&N}WSHCKTB@Rezblg>R@wVcRLL&eCB<MR=~18<T?@7vwbJ<6t?44f`;8>4z8{?O
ziwKRWZ3ete__tTF3{5R_Z5UP~9dB&jmLEAbu__-NleEBZ1=sIjWKWnR^IOw8gwH|p
z)4-~#K-jY-{*x<()pR<j>Jwvn)e`*3ela0%0{#R0d4`!BnDq+eW2XZt+_LM|aqm@Q
zC`_OJUzZva?W)_!JU{sA%d?Q!vd$y;54CdQ7%-h#r<pCKdD%E@2;ug<)fyUpW8V5O
zdLzUBhh~fpUU0sqC%B?8t^0Owu6eq{xZIZcbM0TYeLMnrM_p~IUO!BzR$x61Rf5+C
zn-83LJs^dMbJ+M^4a2>_2D}wjJxx0U+Q2$2RrTnew=Bp3b4TH*6ovR#q`voI*F$lj
zL5G8LKL7qRDk1Xk+XvkSE<i(e+vsY-kXx)LZJxOT2-Y)8A0(eLCuw7{WzLI&IOP3e
zlh1y<k|5>Gw8ws<c##xxckO+zkrZ`Ttw-jwy-b$T@D)gUeUR7O?=Yzh-^+wyW-(Vy
z7IxF}9!n5ctKhpra23@*A}SJ5hW@wFiwv(1xa_d74a*wy8oa(G+NVgX9<kIxPU#;r
zzD-oMLgc(2wef0xw6i4x6?o))Xm{EU^6`2<*R7`}I&vK=9y0B=Lz@y!@pxd+t@5Nd
z><SGBb7-AP^$s04*uDf$s`IQ+JJ>Mmu=ZxE&qg1MCTTp$?q!hLUn=jKi?+rWf1%ka
z=wF^a&}L#j5-_vY>a###kUZ!<sN;U(WNPxXP(ZM@=Ui|<Rb6V=_&Oi+ME`VKzq$g=
rSIGusQ`@zr{g;YAKS=${ujD=fT=Mch!ym;ik&&AHW?_=MjeX`nSuMU_

literal 0
HcmV?d00001

diff --git a/templates/partials/active_modal.tmpl b/templates/partials/active_modal.tmpl
index dfbf9ed..fe34a46 100644
--- a/templates/partials/active_modal.tmpl
+++ b/templates/partials/active_modal.tmpl
@@ -9,7 +9,7 @@
       {{if eq .FileType "image"}}
         <img src="/files/{{ .Filename }}" class="img-fluid" alt="Responsive image">
       {{else if eq .FileType "application"}}
-        <embed src="/files/{{ .Filename }}" width="500" height="375">
+        <img src="/static/zip-icon.png" class="img-fluid" alt="Responsive image">
       {{end}}
       </div>
       <div class="modal-footer">

From 6ec9ee8193c9af80d6911a932125240cdf70eee1 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Daniel=20Omar=20Vergara=20P=C3=A9rez?=
 <daniel.omar.vergara@gmail.com>
Date: Fri, 13 Sep 2024 20:39:36 -0600
Subject: [PATCH 06/11] fix(docker): add non-root user to the dockerfile

---
 Dockerfile         | 4 ++++
 docker-compose.yml | 4 ++++
 2 files changed, 8 insertions(+)

diff --git a/Dockerfile b/Dockerfile
index 617dee1..777fab1 100644
--- a/Dockerfile
+++ b/Dockerfile
@@ -35,6 +35,10 @@ COPY --from=builder /usr/share/fonts /usr/share/fonts
 
 ENV FONTCONFIG_PATH /usr/share/fonts
 
+# Use morphos as user
+RUN useradd -m morphos
+USER morphos
+
 EXPOSE 8080
 
 ENTRYPOINT ["/bin/morphos"]
diff --git a/docker-compose.yml b/docker-compose.yml
index 822299a..be70ceb 100644
--- a/docker-compose.yml
+++ b/docker-compose.yml
@@ -2,6 +2,10 @@ name: morphos
 services:
   morphos-server:
     image: ghcr.io/danvergara/morphos-server:latest
+    # uncomment this if you want to build the container yourself.
+    # build:
+    #   context: .
+    #   target: release
     ports:
       - 8080:8080
     volumes:

From 609367bdf58734dc50e70458a7f88f07a6a2e9e7 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Daniel=20Omar=20Vergara=20P=C3=A9rez?=
 <daniel.omar.vergara@gmail.com>
Date: Sat, 14 Sep 2024 21:45:51 -0600
Subject: [PATCH 07/11] fix(templates): shorten the modal title

---
 templates/partials/active_modal.tmpl |  6 ++++--
 templates/partials/js.tmpl           | 13 +++++++++----
 2 files changed, 13 insertions(+), 6 deletions(-)

diff --git a/templates/partials/active_modal.tmpl b/templates/partials/active_modal.tmpl
index fe34a46..512decc 100644
--- a/templates/partials/active_modal.tmpl
+++ b/templates/partials/active_modal.tmpl
@@ -3,7 +3,9 @@
   <div class="modal-dialog modal-dialog-centered">
     <div class="modal-content">
       <div class="modal-header">
-        <h5 class="modal-title">{{ .Filename }}</h5>
+        <div class="modal-title" id="modal-title" title="{{ .Filename }}">
+          {{ .Filename }}
+        </div>
       </div>
       <div class="modal-body">
       {{if eq .FileType "image"}}
@@ -15,7 +17,7 @@
       <div class="modal-footer">
         <a href="/files/{{ .Filename }}" download>
           <button class="btn btn-success">
-            Download {{ .Filename }}
+            Download
           </button>
         </a>
         <button type="button" class="btn btn-secondary" data-bs-dismiss="modal">
diff --git a/templates/partials/js.tmpl b/templates/partials/js.tmpl
index 227966f..9c134e2 100644
--- a/templates/partials/js.tmpl
+++ b/templates/partials/js.tmpl
@@ -29,12 +29,17 @@
     }
   </script>
   <script>
-    htmx.on('htmx:load', function(evt) { updateName(); });
-    htmx.on(window, 'resize', function(evt) { updateName(); });
+    htmx.on('htmx:load', function(evt) { updateName('filename'); });
+    htmx.on(window, 'resize', function(evt) { updateName('filename'); });
+
+    const modal = document.getElementById('modals-here')
+    modal.addEventListener('shown.bs.modal', () => {
+      updateName('modal-title') 
+    })
 
     // Shorten the filename if it's too long to fit in the space available
-    function updateName() {
-      let filenameObj = document.getElementById('filename');
+    function updateName(id) {
+      let filenameObj = document.getElementById(id);
       if (!filenameObj) return; // Not on the download page
 
       let filename = filenameObj.title;

From d6ea6f88d42e0faeb5aa064f47456407104b2dbd Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Daniel=20Omar=20Vergara=20P=C3=A9rez?=
 <daniel.omar.vergara@gmail.com>
Date: Sat, 14 Sep 2024 21:47:02 -0600
Subject: [PATCH 08/11] build(make): set the build target as prerequisite

---
 Makefile | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Makefile b/Makefile
index a937470..663d3da 100644
--- a/Makefile
+++ b/Makefile
@@ -30,7 +30,7 @@ docker-build:
 
 .PHONY: docker-run
 ## docker-run: Runs the container
-docker-run: 
+docker-run: docker-build
 	docker run --rm -p 8080:8080 -v /tmp:/tmp morphos
 
 .PHONY: help

From c42f4bd0d87e197c1b4072921174aac371ce34b6 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Daniel=20Omar=20Vergara=20P=C3=A9rez?=
 <daniel.omar.vergara@gmail.com>
Date: Mon, 16 Sep 2024 22:59:58 -0600
Subject: [PATCH 09/11] feat(main): add api router

---
 main.go | 135 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 135 insertions(+)

diff --git a/main.go b/main.go
index d4a9be0..b08f4bb 100644
--- a/main.go
+++ b/main.go
@@ -4,6 +4,7 @@ import (
 	"bytes"
 	"context"
 	"embed"
+	"encoding/json"
 	"errors"
 	"fmt"
 	"html/template"
@@ -330,6 +331,120 @@ func handleModal(w http.ResponseWriter, r *http.Request) error {
 	return nil
 }
 
+func getFormats(w http.ResponseWriter, r *http.Request) error {
+	resp, err := json.Marshal(supportedFormatsJSONResponse())
+	if err != nil {
+		log.Printf("error ocurred marshalling the response: %v", err)
+		return WithHTTPStatus(err, http.StatusInternalServerError)
+	}
+
+	w.Header().Set("Content-Type", "application/json")
+	if _, err := w.Write(resp); err != nil {
+		log.Printf("error ocurred writting to the ResponseWriter : %v", err)
+		return WithHTTPStatus(err, http.StatusInternalServerError)
+	}
+
+	return nil
+}
+
+func uploadFile(w http.ResponseWriter, r *http.Request) error {
+	var (
+		convertedFile     io.Reader
+		convertedFilePath string
+		convertedFileName string
+		err               error
+	)
+
+	file, fileHeader, err := r.FormFile(uploadFileFormField)
+	if err != nil {
+		log.Printf("error ocurred getting file from form: %v", err)
+		return WithHTTPStatus(err, http.StatusBadRequest)
+	}
+	defer file.Close()
+
+	targetFileSubType := r.FormValue("targetFormat")
+
+	fileBytes, err := io.ReadAll(file)
+	if err != nil {
+		log.Printf("error ocurred reading file: %v", err)
+		return WithHTTPStatus(err, http.StatusInternalServerError)
+	}
+
+	// Call Detect fuction to get the mimetype of the input file.
+	detectedFileType := mimetype.Detect(fileBytes)
+
+	// Parse the mimetype to get the type and the sub-type of the input file.
+	fileType, subType, err := files.TypeAndSupType(detectedFileType.String())
+	if err != nil {
+		log.Printf("error occurred getting type and subtype from mimetype: %v", err)
+		return WithHTTPStatus(err, http.StatusBadRequest)
+
+	}
+	// Get the right factory based off the input file type.
+	fileFactory, err := files.BuildFactory(fileType, fileHeader.Filename)
+	if err != nil {
+		log.Printf("error occurred while getting a file factory: %v", err)
+		return WithHTTPStatus(err, http.StatusBadRequest)
+	}
+
+	f, err := fileFactory.NewFile(subType)
+	if err != nil {
+		log.Printf("error occurred getting the file object: %v", err)
+		return WithHTTPStatus(err, http.StatusBadRequest)
+	}
+
+	// Return the kind of the output file.
+	targetFileType := files.SupportedFileTypes()[targetFileSubType]
+
+	// Convert the file to the target format.
+	// convertedFile is an io.Reader.
+	convertedFile, err = f.ConvertTo(
+		cases.Title(language.English).String(targetFileType),
+		targetFileSubType,
+		bytes.NewReader(fileBytes),
+	)
+	if err != nil {
+		log.Printf("error ocurred while processing the input file: %v", err)
+		return WithHTTPStatus(err, http.StatusInternalServerError)
+	}
+
+	switch fileType {
+	case "application", "text":
+		targetFileSubType = "zip"
+	}
+
+	convertedFileName = filename(fileHeader.Filename, targetFileSubType)
+	convertedFilePath = filepath.Join(uploadPath, convertedFileName)
+
+	newFile, err := os.Create(convertedFilePath)
+	if err != nil {
+		log.Printf("error occurred while creating the output file: %v", err)
+		return WithHTTPStatus(err, http.StatusInternalServerError)
+	}
+	defer newFile.Close()
+
+	buf := new(bytes.Buffer)
+	if _, err := buf.ReadFrom(convertedFile); err != nil {
+		log.Printf("error occurred while readinf from the converted file: %v", err)
+		return WithHTTPStatus(err, http.StatusInternalServerError)
+	}
+
+	convertedFileBytes := buf.Bytes()
+	if _, err := newFile.Write(convertedFileBytes); err != nil {
+		log.Printf("error occurred writing converted output to a file in disk: %v", err)
+		return WithHTTPStatus(err, http.StatusInternalServerError)
+	}
+
+	w.WriteHeader(http.StatusOK)
+	w.Header().Set("Content-Type", "application/octet-stream")
+	if _, err := w.Write(convertedFileBytes); err != nil {
+		log.Printf("error occurred writing converted file to response writer: %v", err)
+		return WithHTTPStatus(err, http.StatusInternalServerError)
+	}
+
+	return nil
+}
+
 func newRouter() http.Handler {
 	r := chi.NewRouter()
 	r.Use(middleware.Logger)
@@ -344,6 +459,13 @@ func newRouter() http.Handler {
 	return r
 }
 
+func apiRouter() http.Handler {
+	r := chi.NewRouter()
+	r.Get("/formats", toHandler(getFormats))
+	r.Post("/upload", toHandler(uploadFile))
+	return r
+}
+
 func addRoutes(r *chi.Mux, fs, fsUpload http.Handler) {
 	r.HandleFunc("/healthz", healthz)
 	r.Handle("/static/*", fs)
@@ -352,6 +474,9 @@ func addRoutes(r *chi.Mux, fs, fsUpload http.Handler) {
 	r.Post("/upload", toHandler(handleUploadFile))
 	r.Post("/format", toHandler(handleFileFormat))
 	r.Get("/modal", toHandler(handleModal))
+
+	// Mount the api router.
+	r.Mount("/api/v1", apiRouter())
 }
 
 func run(ctx context.Context) error {
@@ -436,3 +561,13 @@ func filename(filename, extension string) string {
 func healthz(w http.ResponseWriter, r *http.Request) {
 	w.WriteHeader(http.StatusOK)
 }
+
+func supportedFormatsJSONResponse() map[string][]string {
+	result := make(map[string][]string)
+
+	for k, v := range files.SupportedFileTypes() {
+		result[v] = append(result[v], k)
+	}
+
+	return result
+}

From 2a23672d013e62267a1266d9c59096080ce11df6 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Daniel=20Omar=20Vergara=20P=C3=A9rez?=
 <daniel.omar.vergara@gmail.com>
Date: Tue, 17 Sep 2024 23:49:29 -0600
Subject: [PATCH 10/11] refactor(main): refactor the functions and handlers
 that are responsible to convert input files

---
 main.go                      | 294 ++++++++++++++---------------------
 templates/partials/form.tmpl |   2 +-
 2 files changed, 115 insertions(+), 181 deletions(-)

diff --git a/main.go b/main.go
index b08f4bb..e17268c 100644
--- a/main.go
+++ b/main.go
@@ -135,95 +135,9 @@ func index(w http.ResponseWriter, _ *http.Request) error {
 }
 
 func handleUploadFile(w http.ResponseWriter, r *http.Request) error {
-	var (
-		convertedFile     io.Reader
-		convertedFilePath string
-		convertedFileName string
-		err               error
-	)
-
-	// Parse and validate file and post parameters.
-	file, fileHeader, err := r.FormFile(uploadFileFormField)
-	if err != nil {
-		log.Printf("error ocurred getting file from form: %v", err)
-		return WithHTTPStatus(err, http.StatusBadRequest)
-	}
-	defer file.Close()
-
-	// Get the content of the file in form of a slice of bytes.
-	fileBytes, err := io.ReadAll(file)
-	if err != nil {
-		log.Printf("error ocurred reading file: %v", err)
-		return WithHTTPStatus(err, http.StatusBadRequest)
-	}
-
-	// Get the sub-type of the input file from the form.
-	targetFileSubType := r.FormValue("input_format")
-
-	// Call Detect fuction to get the mimetype of the input file.
-	detectedFileType := mimetype.Detect(fileBytes)
-
-	// Parse the mimetype to get the type and the sub-type of the input file.
-	fileType, subType, err := files.TypeAndSupType(detectedFileType.String())
-	if err != nil {
-		log.Printf("error occurred getting type and subtype from mimetype: %v", err)
-		return WithHTTPStatus(err, http.StatusBadRequest)
-	}
-
-	// Get the right factory based off the input file type.
-	fileFactory, err := files.BuildFactory(fileType, fileHeader.Filename)
-	if err != nil {
-		log.Printf("error occurred while getting a file factory: %v", err)
-		return WithHTTPStatus(err, http.StatusBadRequest)
-	}
-
-	// Returns an object that implements the File interface based on the sub-type of the input file.
-	f, err := fileFactory.NewFile(subType)
-	if err != nil {
-		log.Printf("error occurred getting the file object: %v", err)
-		return WithHTTPStatus(err, http.StatusBadRequest)
-	}
-
-	// Return the kind of the output file.
-	targetFileType := files.SupportedFileTypes()[targetFileSubType]
-
-	// Convert the file to the target format.
-	// convertedFile is an io.Reader.
-	convertedFile, err = f.ConvertTo(
-		cases.Title(language.English).String(targetFileType),
-		targetFileSubType,
-		bytes.NewReader(fileBytes),
-	)
+	convertedFileName, convertedFileType, _, err := convertFile(r)
 	if err != nil {
-		log.Printf("error ocurred while processing the input file: %v", err)
-		return WithHTTPStatus(err, http.StatusInternalServerError)
-	}
-
-	switch fileType {
-	case "application", "text":
-		targetFileSubType = "zip"
-	}
-
-	convertedFileName = filename(fileHeader.Filename, targetFileSubType)
-	convertedFilePath = filepath.Join(uploadPath, convertedFileName)
-
-	newFile, err := os.Create(convertedFilePath)
-	if err != nil {
-		log.Printf("error occurred while creating the output file: %v", err)
-		return WithHTTPStatus(err, http.StatusInternalServerError)
-	}
-	defer newFile.Close()
-
-	buf := new(bytes.Buffer)
-	if _, err := buf.ReadFrom(convertedFile); err != nil {
-		log.Printf("error occurred while readinf from the converted file: %v", err)
-		return WithHTTPStatus(err, http.StatusInternalServerError)
-	}
-
-	convertedFileBytes := buf.Bytes()
-	if _, err := newFile.Write(convertedFileBytes); err != nil {
-		log.Printf("error occurred writing converted output to a file in disk: %v", err)
-		return WithHTTPStatus(err, http.StatusInternalServerError)
+		return err
 	}
 
 	tmpls := []string{
@@ -237,14 +151,6 @@ func handleUploadFile(w http.ResponseWriter, r *http.Request) error {
 		return WithHTTPStatus(err, http.StatusInternalServerError)
 	}
 
-	convertedFileMimeType := mimetype.Detect(convertedFileBytes)
-
-	convertedFileType, _, err := files.TypeAndSupType(convertedFileMimeType.String())
-	if err != nil {
-		log.Printf("error occurred getting the file type of the result file: %v", err)
-		return WithHTTPStatus(err, http.StatusInternalServerError)
-	}
-
 	err = tmpl.ExecuteTemplate(
 		w,
 		"content",
@@ -348,91 +254,9 @@ func getFormats(w http.ResponseWriter, r *http.Request) error {
 }
 
 func uploadFile(w http.ResponseWriter, r *http.Request) error {
-	var (
-		convertedFile     io.Reader
-		convertedFilePath string
-		convertedFileName string
-		err               error
-	)
-
-	file, fileHeader, err := r.FormFile(uploadFileFormField)
-	if err != nil {
-		log.Printf("error ocurred getting file from form: %v", err)
-		return WithHTTPStatus(err, http.StatusBadRequest)
-	}
-	defer file.Close()
-
-	targetFileSubType := r.FormValue("targetFormat")
-
-	fileBytes, err := io.ReadAll(file)
-	if err != nil {
-		log.Printf("error ocurred reading file: %v", err)
-		return WithHTTPStatus(err, http.StatusInternalServerError)
-	}
-
-	// Call Detect fuction to get the mimetype of the input file.
-	detectedFileType := mimetype.Detect(fileBytes)
-
-	// Parse the mimetype to get the type and the sub-type of the input file.
-	fileType, subType, err := files.TypeAndSupType(detectedFileType.String())
-	if err != nil {
-		log.Printf("error occurred getting type and subtype from mimetype: %v", err)
-		return WithHTTPStatus(err, http.StatusBadRequest)
-
-	}
-	// Get the right factory based off the input file type.
-	fileFactory, err := files.BuildFactory(fileType, fileHeader.Filename)
-	if err != nil {
-		log.Printf("error occurred while getting a file factory: %v", err)
-		return WithHTTPStatus(err, http.StatusBadRequest)
-	}
-
-	f, err := fileFactory.NewFile(subType)
+	_, _, convertedFileBytes, err := convertFile(r)
 	if err != nil {
-		log.Printf("error occurred getting the file object: %v", err)
-		return WithHTTPStatus(err, http.StatusBadRequest)
-	}
-
-	// Return the kind of the output file.
-	targetFileType := files.SupportedFileTypes()[targetFileSubType]
-
-	// Convert the file to the target format.
-	// convertedFile is an io.Reader.
-	convertedFile, err = f.ConvertTo(
-		cases.Title(language.English).String(targetFileType),
-		targetFileSubType,
-		bytes.NewReader(fileBytes),
-	)
-	if err != nil {
-		log.Printf("error ocurred while processing the input file: %v", err)
-		return WithHTTPStatus(err, http.StatusInternalServerError)
-	}
-
-	switch fileType {
-	case "application", "text":
-		targetFileSubType = "zip"
-	}
-
-	convertedFileName = filename(fileHeader.Filename, targetFileSubType)
-	convertedFilePath = filepath.Join(uploadPath, convertedFileName)
-
-	newFile, err := os.Create(convertedFilePath)
-	if err != nil {
-		log.Printf("error occurred while creating the output file: %v", err)
-		return WithHTTPStatus(err, http.StatusInternalServerError)
-	}
-	defer newFile.Close()
-
-	buf := new(bytes.Buffer)
-	if _, err := buf.ReadFrom(convertedFile); err != nil {
-		log.Printf("error occurred while readinf from the converted file: %v", err)
-		return WithHTTPStatus(err, http.StatusInternalServerError)
-	}
-
-	convertedFileBytes := buf.Bytes()
-	if _, err := newFile.Write(convertedFileBytes); err != nil {
-		log.Printf("error occurred writing converted output to a file in disk: %v", err)
-		return WithHTTPStatus(err, http.StatusInternalServerError)
+		return err
 	}
 
 	w.WriteHeader(http.StatusOK)
@@ -562,6 +386,116 @@ func healthz(w http.ResponseWriter, r *http.Request) {
 	w.WriteHeader(http.StatusOK)
 }
 
+// convertFile handles everything required to convert a file.
+// It returns the name of the file, the target file type, the file as a slice of bytes and a possible error.
+// It is both used by the HTML form and the API.
+func convertFile(r *http.Request) (string, string, []byte, error) {
+	var (
+		convertedFile     io.Reader
+		convertedFilePath string
+		convertedFileName string
+		err               error
+	)
+
+	// Parse and validate file and post parameters.
+	file, fileHeader, err := r.FormFile(uploadFileFormField)
+	if err != nil {
+		log.Printf("error ocurred getting file from form: %v", err)
+		return "", "", nil, WithHTTPStatus(err, http.StatusBadRequest)
+	}
+	defer file.Close()
+
+	// Get the content of the file in form of a slice of bytes.
+	fileBytes, err := io.ReadAll(file)
+	if err != nil {
+		log.Printf("error ocurred reading file: %v", err)
+		return "", "", nil, WithHTTPStatus(err, http.StatusBadRequest)
+	}
+
+	// Get the sub-type of the input file from the form.
+	targetFileSubType := r.FormValue("targetFormat")
+
+	// Call Detect fuction to get the mimetype of the input file.
+	detectedFileType := mimetype.Detect(fileBytes)
+
+	// Parse the mimetype to get the type and the sub-type of the input file.
+	fileType, subType, err := files.TypeAndSupType(detectedFileType.String())
+	if err != nil {
+		log.Printf("error occurred getting type and subtype from mimetype: %v", err)
+		return "", "", nil, WithHTTPStatus(err, http.StatusBadRequest)
+	}
+
+	// Get the right factory based off the input file type.
+	fileFactory, err := files.BuildFactory(fileType, fileHeader.Filename)
+	if err != nil {
+		log.Printf("error occurred while getting a file factory: %v", err)
+		return "", "", nil, WithHTTPStatus(err, http.StatusBadRequest)
+	}
+
+	// Returns an object that implements the File interface based on the sub-type of the input file.
+	f, err := fileFactory.NewFile(subType)
+	if err != nil {
+		log.Printf("error occurred getting the file object: %v", err)
+		return "", "", nil, WithHTTPStatus(err, http.StatusBadRequest)
+	}
+
+	// Return the kind of the output file.
+	targetFileType := files.SupportedFileTypes()[targetFileSubType]
+
+	// Convert the file to the target format.
+	// convertedFile is an io.Reader.
+	convertedFile, err = f.ConvertTo(
+		cases.Title(language.English).String(targetFileType),
+		targetFileSubType,
+		bytes.NewReader(fileBytes),
+	)
+	if err != nil {
+		log.Printf("error ocurred while processing the input file: %v", err)
+		return "", "", nil, WithHTTPStatus(err, http.StatusInternalServerError)
+	}
+
+	switch fileType {
+	case "application", "text":
+		targetFileSubType = "zip"
+	}
+
+	convertedFileName = filename(fileHeader.Filename, targetFileSubType)
+	convertedFilePath = filepath.Join(uploadPath, convertedFileName)
+
+	newFile, err := os.Create(convertedFilePath)
+	if err != nil {
+		log.Printf("error occurred while creating the output file: %v", err)
+		return "", "", nil, WithHTTPStatus(err, http.StatusInternalServerError)
+	}
+	defer newFile.Close()
+
+	buf := new(bytes.Buffer)
+	if _, err := buf.ReadFrom(convertedFile); err != nil {
+		log.Printf("error occurred while readinf from the converted file: %v", err)
+		return "", "", nil, WithHTTPStatus(err, http.StatusInternalServerError)
+	}
+
+	convertedFileBytes := buf.Bytes()
+	if _, err := newFile.Write(convertedFileBytes); err != nil {
+		log.Printf("error occurred writing converted output to a file in disk: %v", err)
+		return "", "", nil, WithHTTPStatus(err, http.StatusInternalServerError)
+	}
+
+	convertedFileMimeType := mimetype.Detect(convertedFileBytes)
+
+	convertedFileType, _, err := files.TypeAndSupType(convertedFileMimeType.String())
+	if err != nil {
+		log.Printf("error occurred getting the file type of the result file: %v", err)
+		return "", "", nil, WithHTTPStatus(err, http.StatusInternalServerError)
+	}
+
+	return convertedFileName, convertedFileType, convertedFileBytes, nil
+}
+
+// supportedFormatsJSONResponse returns the supported formas as a map formatted to be shown as JSON.
+// The intention of this is showing the supported formats to the client.
+// Example:
+// {"documents": ["docx", "xls"], "image": ["png", "jpeg"]}
 func supportedFormatsJSONResponse() map[string][]string {
 	result := make(map[string][]string)
 
diff --git a/templates/partials/form.tmpl b/templates/partials/form.tmpl
index 0f679dd..eff0b56 100644
--- a/templates/partials/form.tmpl
+++ b/templates/partials/form.tmpl
@@ -24,7 +24,7 @@
         </div>
         <div class="col-sm">
           <label for="input-format" class="form-label">Formats to convert</label>
-          <select id="input-format" class="form-select" name="input_format">
+          <select id="input-format" class="form-select" name="targetFormat">
             {{ block "format-elements" . }}
               {{ range $family, $formats := . }}
                 <optgroup label="{{ $family }}">

From b56800f7d0c0b63a2e46e9e1f5cf573d62797959 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Daniel=20Omar=20Vergara=20P=C3=A9rez?=
 <daniel.omar.vergara@gmail.com>
Date: Tue, 17 Sep 2024 23:50:10 -0600
Subject: [PATCH 11/11] docs(README): add documentation on how to use the api

---
 README.md | 32 ++++++++++++++++++++++++++++++++
 1 file changed, 32 insertions(+)

diff --git a/README.md b/README.md
index de3c26f..dc60f13 100644
--- a/README.md
+++ b/README.md
@@ -44,6 +44,8 @@ docker run --rm -p 8080:8080 -v /tmp:/tmp ghcr.io/danvergara/morphos-server:late
 
 ## Usage
 
+### HTML form
+
 Run the server as mentioned above and open up your favorite browser. You'll see something like this:
 
 <img src="screenshots/morphos.png"/>
@@ -68,6 +70,36 @@ A modal will pop up with a preview of the converted image.
 
 <img src="screenshots/modal_morphos.png"/>
 
+### API
+
+You can consume morphos through an API, so other systems can integrate with it.
+
+##### Endpoints
+
+`GET /api/v1/formats`
+
+This returns a JSON that shows the supported formats at the moment.
+
+e.g.
+
+```
+{"documents": ["docx", "xls"], "image": ["png", "jpeg"]}
+```
+
+`POST /api/v1/upload`
+
+This is the endpoint that converts files to a desired format. It is basically a multipart form data in a POST request. The API simply writes the converted files to the response body.
+
+e.g.
+
+```
+ curl -F 'targetFormat=epub' -F 'uploadFile=@/path/to/file/foo.pdf' localhost:8080/api/v1/upload --output foo.epub
+```
+The form fields are:
+
+* targetFormat: the target format the file will be converted to
+* uploadFile: The path to the file that is going to be converted
+
 ### Configuration
 
 The configuration is only done by the environment varibles shown below.