From 76e3044e32e45c76398e8a6f58e11f640f272f58 Mon Sep 17 00:00:00 2001 From: Herwin Date: Tue, 22 Feb 2022 15:13:59 +0100 Subject: [PATCH] Improved readme and added remarks in files Update .gitignore, test01.json, and readme.md --- .gitignore | 2 +- content/items/test01.json | 2 +- readme.md | 29 ++++++++++++++++++++++++++--- 3 files changed, 28 insertions(+), 5 deletions(-) diff --git a/.gitignore b/.gitignore index ddf9741..d7bb56b 100644 --- a/.gitignore +++ b/.gitignore @@ -11,6 +11,6 @@ resources/HalfMoon/ resources/Icons8/ resources/Quantum/ -# Other folders +# Other folders (Will be removed once the content system is finished !) content/page/ files/ diff --git a/content/items/test01.json b/content/items/test01.json index 0e0dcd2..0ef8827 100644 --- a/content/items/test01.json +++ b/content/items/test01.json @@ -1,3 +1,3 @@ { - + "_": "Is this file used anywhere ?" } \ No newline at end of file diff --git a/readme.md b/readme.md index 6b6bb7e..ac7b07a 100644 --- a/readme.md +++ b/readme.md @@ -1,8 +1,30 @@ # Website - NibblePoker.lu -TODO. +Repository containing the source code for my website. -## Warning -TODO: Remark about folders and files to remove ! +## Preamble +This repository is only a mirror and is never cloned and served as-is. + +In the event you wished to mirror and serve it, or modify it, you should make sure +the `.git` folder and the other files referenced in the [.dockerignore](.dockerignore) +file are properly removed, even if measures are in place to prevent access to them. + +The [.htaccess](.htaccess) file has been made public **on purpose** since it does not contains any +private information and because it could be used by other people to create their website more easily +since these files are a pain to work with. + +It is also a good idea to server this website through a jailed instance of apache, just in case. + +## Content +### Blog +Unfinished, but all the files should be contained in the `content/` folder. + +### Honeypot & Tarpits +There are a couple of files in the `honeypot/` and `tarpit/` folders that are used +to serve some basic fake files that are often requested by automated scanners in order +to mess with them, or potentially force them to report invalid data. + +These pages can be removed by deleting the folders and removing the appropriate rules in +the [.htaccess](.htaccess) file. ## Requirements These files are not present in this repo since they @@ -11,6 +33,7 @@ would clutter the commits and potentially break some licensing rules. ### Required These files are required for the website to work properly !
+* Apache & * PHP 8 or newer * Font Awesome Pro v5.15.3 * `/resources/FontAwesomePro/` * HalfMoon v1.1.1