From 9e3e0c247ca510af9138a0446a3aa0e66b824659 Mon Sep 17 00:00:00 2001 From: gigirassy Date: Sat, 18 Jul 2026 05:26:41 +0200 Subject: [PATCH] Update README.md --- README.md | 45 ++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 44 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5744c22..c85fba9 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,8 @@ it is compiled with ``panic=immediate-abort``. ## example usage +### compose file + in a compose file, you can use teletraan to run your static site stack: ```yaml @@ -48,7 +50,48 @@ services: - "127.0.0.1:9904:3000" ``` -and then use external caddy or nginx to reverse proxy the host ports. +use external caddy or nginx to reverse proxy the host ports either way. + + +### dockerfile +an image of cinny can be easily and quickly built with teletraan as the server. we just need to specify ``CMD ["-s"]`` at the end. + +``` +FROM ghcr.io/cinnyapp/cinny:v4.12.3 AS source + +FROM codeberg.org/gigirassy/teletraan:latest AS runtime + +COPY --from=source /usr/share/nginx/html . + +EXPOSE 3000 + +CMD ["-s"] +``` + +a simple image for your static site can be built easily. you dont have to specify a cmd! + +``` +FROM codeberg.org/gigirassy/teletraan:latest + +COPY /static . + +EXPOSE 3000 +``` + +if your static site is made of txt files, use the ``CMD ["-i"]`` flag to serve your index.txt file in the webroot as the index. + +``` +FROM codeberg.org/gigirassy/teletraan:latest + +COPY /doc . + +EXPOSE 3000 + +CMD ["-i"] +``` + +use external caddy or nginx to reverse proxy the host ports either way. + ## license