diff --git a/README.md b/README.md index 3daf8ef..f69c314 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,40 @@ -# agate-gemini +# agate-gemini docker image -A gemini server using Agate \ No newline at end of file +A Gemini server using Agate. + +This image is created having in mind to be used with a Traefik proxy server which will deal with the certication. That's why no certification is created inside the image in build time. + +To use it with Traefik and docker-compose you need to create two files with the following content in the same folder. + +.env +``` +PROJECT_NAME=mygemini +HOSTNAME=mygemini.demo.com +``` + +docker-compose.yml +```yaml +version: "3" + +services: + agate: + image: walkero/agate-gemini + container_name: "${PROJECT_NAME}_agate" + environment: + HOSTNAME: ${HOSTNAME} + volumes: + - ./content:/home/gemini/content + labels: + - "traefik.enable=true" + - traefik.tcp.routers.${PROJECT_NAME}_gemini.entrypoints=gemini + - traefik.tcp.routers.${PROJECT_NAME}_gemini.rule=HostSNI(`*`) + - traefik.tcp.routers.${PROJECT_NAME}_gemini.service=${PROJECT_NAME}_gemini + - traefik.tcp.services.${PROJECT_NAME}_gemini.loadbalancer.server.port=1965 +``` + +To create the container you just need to run: +``` +docker-compose up -d +``` + +Your gemtext files should be added at the `content` folder. Those are accessible from the container as well. \ No newline at end of file