summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorthrowaway <developerthrowaway@protonmail.com>2023-09-12 21:43:31 -0500
committerlolcat <lolcat@no-reply@lolcat.ca>2023-09-12 21:43:31 -0500
commit24a00eb2e25d653b885a8e373425d3a279490c2a (patch)
tree928cbf616fe655281b3260be85506f98fdc5ed4b /README.md
parent71a61304b0072694174af559368a10b69d1e21e4 (diff)
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 <developerthrowaway@protonmail.com> Co-committed-by: throwaway <developerthrowaway@protonmail.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md35
1 files changed, 31 insertions, 4 deletions
diff --git a/README.md b/README.md
index 99e8a86..0214e13 100644
--- a/README.md
+++ b/README.md
@@ -225,12 +225,39 @@ Obviously replace `<youronionaddress>` 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`
+