From 24a00eb2e25d653b885a8e373425d3a279490c2a Mon Sep 17 00:00:00 2001 From: throwaway Date: Tue, 12 Sep 2023 21:43:31 -0500 Subject: [PATCH] add docker-compose.yaml and instructions (#12) add docker-compose.yaml and instructions Reviewed-on: https://git.lolcat.ca/lolcat/4get/pulls/12 Co-authored-by: throwaway Co-committed-by: throwaway --- README.md | 35 +++++++++++++++++++++++++++++++---- docker-compose.yaml | 17 +++++++++++++++++ 2 files changed, 48 insertions(+), 4 deletions(-) create mode 100644 docker-compose.yaml diff --git a/README.md b/README.md index 99e8a86..0214e13 100644 --- a/README.md +++ b/README.md @@ -225,12 +225,39 @@ Obviously replace `` by the onion address of `/var/lib/tor/4ge ## Docker Install ``` -git clone https://git.lolcat.ca/lolcat/4get -cd 4get -docker build -t 4get . -docker run -d -p 80:80 -p 443:443 -e FOURGET_SERVER_NAME="4get.ca" -e FOURGET_SERVER_ADMIN_EMAIL="you@example.com" -v /etc/letsencrypt/live/domain.tld:/etc/4get/certs 4get +docker run -d -p 80:80 -p 443:443 -e FOURGET_SERVER_NAME="4get.ca" -e FOURGET_SERVER_ADMIN_EMAIL="you@example.com" -v /etc/letsencrypt/live/domain.tld:/etc/4get/certs luuul/4get:1.0.0 ``` replace enviroment variables FOURGET_SERVER_NAME and FOURGET_SERVER_ADMIN_EMAIL with relevant values the certs directory expects files named `cert.pem`, `chain.pem`, `privkey.pem` + +## Docker compose + +copy `docker-compose.yaml` + +create a directory with images named `banners` for example and mount to `/var/www/html/4get/banner` +to serve custom banners + +``` +version: "3.7" + +services: + fourget: + image: luuul/4get:1.0.0 + restart: always + environment: + - FOURGET_SERVER_NAME=4get.ca + - FOURGET_SERVER_ADMIN_EMAIL="you@example.com" + + ports: + - "80:80" + - "443:443" + + volumes: + - /etc/letsencrypt/live/domain.tld:/etc/4get/certs + - ./banners:/var/www/html/4get/banner +``` + +Replace relevant values and start with `docker-compose up -d` + diff --git a/docker-compose.yaml b/docker-compose.yaml new file mode 100644 index 0000000..3c34548 --- /dev/null +++ b/docker-compose.yaml @@ -0,0 +1,17 @@ +version: "3.7" + +services: + fourget: + image: luuul/4get:1.0.0 + restart: always + environment: + - FOURGET_SERVER_NAME=beak.chat + - FOURGET_SERVER_ADMIN_EMAIL="you@example.com" + + ports: + - "80:80" + - "443:443" + + volumes: + - /etc/letsencrypt/live/domain.tld:/etc/4get/certs + - ./banners:/var/www/html/4get/banner