From 075990b316af9263ee7f15a3a1c40106733b7f13 Mon Sep 17 00:00:00 2001 From: brooke Date: Mon, 23 Oct 2023 07:13:27 +0000 Subject: [PATCH 1/9] Add ISSUES.md --- ISSUES.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 ISSUES.md diff --git a/ISSUES.md b/ISSUES.md new file mode 100644 index 0000000..92ed8ec --- /dev/null +++ b/ISSUES.md @@ -0,0 +1,20 @@ +# Issue Template + +## [Issue Title] + +### Expected behavior + +- Expected behavior: [Expected behavior] + +### Description + +[Paragraph describing your issue] + +### Environment + +- Browser: [Browser and Version] +- Extensions: [Extensions] + +--- + +[Additional notes, information, or comments.] \ No newline at end of file From a3d11d366c43f04b785aebc6f74f62e2c57762e0 Mon Sep 17 00:00:00 2001 From: brooke Date: Mon, 23 Oct 2023 07:25:08 +0000 Subject: [PATCH 2/9] Add LICENSE --- LICENSE | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..1500199 --- /dev/null +++ b/LICENSE @@ -0,0 +1,9 @@ +MIT License + +Copyright (c) 2023 Squat the Planet + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. From 99f8c134b1154c2a3db997734a2073e8a0f36f1e Mon Sep 17 00:00:00 2001 From: brooke Date: Mon, 23 Oct 2023 07:25:46 +0000 Subject: [PATCH 3/9] 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 From cb6086b9c8becbb5dc01b77212368557f56c9b86 Mon Sep 17 00:00:00 2001 From: brooke Date: Mon, 23 Oct 2023 07:27:35 +0000 Subject: [PATCH 4/9] Update LICENSE --- LICENSE | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/LICENSE b/LICENSE index 1500199..719b497 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2023 Squat the Planet +No rights reserved Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: From 585a1f1316efc1f9f9899371e8bda0b10c305512 Mon Sep 17 00:00:00 2001 From: brooke Date: Tue, 24 Oct 2023 03:08:23 +0000 Subject: [PATCH 5/9] Update ISSUES.md --- ISSUES.md | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/ISSUES.md b/ISSUES.md index 92ed8ec..d0970c5 100644 --- a/ISSUES.md +++ b/ISSUES.md @@ -1,19 +1,26 @@ -# Issue Template +# Issue Template (Delete this header after copying) ## [Issue Title] ### Expected behavior -- Expected behavior: [Expected behavior] +[Describe what you expected to happen] ### Description -[Paragraph describing your issue] +[Describe your issue in as much detail as possible] -### Environment +### Environment (Fill in one, delete the other) +Debian: +- Debian Version: +- Docker Version: +- Docker Compose File: +[Place your compose file here, the starting and ending line should be ``` to make it a codeblock] + +Web: - Browser: [Browser and Version] -- Extensions: [Extensions] +- Extensions: [Installed and running extensions] --- From 0adbfc5d6265bfed1929f3ea95ca33207c25307d Mon Sep 17 00:00:00 2001 From: brooke Date: Tue, 24 Oct 2023 03:09:48 +0000 Subject: [PATCH 6/9] Update ISSUES.md --- ISSUES.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/ISSUES.md b/ISSUES.md index d0970c5..8c425b7 100644 --- a/ISSUES.md +++ b/ISSUES.md @@ -12,13 +12,18 @@ ### Environment (Fill in one, delete the other) -Debian: +#### Debian: - Debian Version: - Docker Version: - Docker Compose File: -[Place your compose file here, the starting and ending line should be ``` to make it a codeblock] -Web: +[Starting and ending line should be ``` to make it a codeblock] + +- Docker .env File: + +[Starting and ending line should be ``` to make it a codeblock] + +#### Web: - Browser: [Browser and Version] - Extensions: [Installed and running extensions] From 6df1ddbfeb220b53b4177078ffe03a20a909fb6b Mon Sep 17 00:00:00 2001 From: brooke Date: Sun, 5 Nov 2023 04:54:07 +0000 Subject: [PATCH 7/9] Update README.md --- README.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index aba0fde..199ed28 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,12 @@ 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. +Copy .env.example to .env and fill in the relevant information, this should match the db you are importing from. +``` +cp .env.example .env +``` + +Place xenforo files at xenforo/_data (or alter the directory in docker-compose.yml 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 @@ -26,17 +31,15 @@ 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 +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" +To report an issue go to https://github.com/Myco-Systems/stp-xenforo-mirror/blob/main/ISSUES.md and copy the raw markdown, then head over to https://github.com/Myco-Systems/stp-xenforo-mirror/issues and press "New Issue" ## License From a865c8e2019535ea763fce474be330418964674c Mon Sep 17 00:00:00 2001 From: brooke Date: Sun, 5 Nov 2023 04:54:39 +0000 Subject: [PATCH 8/9] Update README.md --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 199ed28..f1320c5 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,8 @@ # Xenforo StP Repo +Github mirror: +https://github.com/Myco-Systems/stp-xenforo-mirror/ + ## Downloading and building (run as root or enable docker rootless) ``` curl -sSfL get.docker.com | bash From eb9847ff99e8a8c4e6363e9cd6655d0d396afe60 Mon Sep 17 00:00:00 2001 From: brooke Date: Sun, 5 Nov 2023 22:17:03 +0000 Subject: [PATCH 9/9] Update README.md --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index f1320c5..e56ae02 100644 --- a/README.md +++ b/README.md @@ -42,8 +42,14 @@ After that the nginx webserver will be running on port 8080, currently the expec ## Issues +### Github + To report an issue go to https://github.com/Myco-Systems/stp-xenforo-mirror/blob/main/ISSUES.md and copy the raw markdown, then head over to https://github.com/Myco-Systems/stp-xenforo-mirror/issues and press "New Issue" +### Gitea + +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.