Improved readme and added remarks in files

Update .gitignore, test01.json, and readme.md
This commit is contained in:
2022-02-22 15:13:59 +01:00
parent 920c923526
commit 76e3044e32
3 changed files with 28 additions and 5 deletions

2
.gitignore vendored
View File

@@ -11,6 +11,6 @@ resources/HalfMoon/
resources/Icons8/ resources/Icons8/
resources/Quantum/ resources/Quantum/
# Other folders # Other folders (Will be removed once the content system is finished !)
content/page/ content/page/
files/ files/

View File

@@ -1,3 +1,3 @@
{ {
"_": "Is this file used anywhere ?"
} }

View File

@@ -1,8 +1,30 @@
# Website - NibblePoker.lu # Website - NibblePoker.lu
TODO. Repository containing the source code for my website.
## Warning ## Preamble
TODO: Remark about folders and files to remove ! 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 ## Requirements
These files are not present in this repo since they 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 ### Required
These files are required for the website to work properly !<br> These files are required for the website to work properly !<br>
* Apache & * PHP 8 or newer
* Font Awesome Pro v5.15.3 * Font Awesome Pro v5.15.3
* `/resources/FontAwesomePro/` * `/resources/FontAwesomePro/`
* HalfMoon v1.1.1 * HalfMoon v1.1.1