From 99f8c134b1154c2a3db997734a2073e8a0f36f1e Mon Sep 17 00:00:00 2001 From: brooke Date: Mon, 23 Oct 2023 07:25:46 +0000 Subject: [PATCH] Update README.md --- README.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/README.md b/README.md index 91467f1..aba0fde 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,9 @@ # Xenforo StP Repo +## Downloading and building (run as root or enable docker rootless) +``` +curl -sSfL get.docker.com | bash +``` ``` git clone https://git.myco.systems/stp/xenforo.git ``` @@ -8,10 +12,33 @@ git clone https://git.myco.systems/stp/xenforo.git cd xenforo ``` +Place xenforo files at xenforo/_data (or alter the directory to match your Xenforo location) mysql can be pointed anywhere, but you should have a persistent directory so you can enter the container and import your db. + ``` docker compose build ``` +## Running + ``` docker compose up -d ``` + +To import your mysql db you need to move your .sql files into a location that the container is attached to then run `docker exec -it /bin/bash` > `cd /var/lib/mysql` (assuming this is the directory the container is attached to) > `mariadb -u -p < ` enter your password and then get a coffee because any databases over 1 GB can take a while. + +Restart the containers +``` +docker compose down && docker compose up +``` +After that the nginx webserver will be running on port 8080, currently the expected behavior is for nginx to be behind a reverse proxy so either you can point the proxy at your-ip:8080 or you can alter the docker compose file to include traefik which can grab ssl certificates for you. + +--- + +## Issues + +To report an issue go to https://git.myco.systems/stp/xenforo/src/branch/main/ISSUES.md and copy the raw markdown, then head over to https://git.myco.systems/stp/xenforo/issues and press "New Issue" + +## License + +All code is licensed under MIT, no rights reserved, no warranty provided. +https://git.myco.systems/stp/xenforo/src/branch/main/LICENSE \ No newline at end of file