From e7691a01363c8b07d692f5ee5ae16056994a2f2b Mon Sep 17 00:00:00 2001 From: fuzzykitten Date: Fri, 7 Mar 2025 10:34:46 -0500 Subject: [PATCH] updated readme file with new paths /opt --- README.md | 35 +++++++++++++++++++++++++---------- 1 file changed, 25 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index e4d87ee..8b06f74 100644 --- a/README.md +++ b/README.md @@ -19,14 +19,21 @@ to make space for all the features I wanted. ### For the users -The textboard allows anonymous posting only, and it has no timestamps. +The textboard allows anonymous and pseudonymous posting, and it has optional, +very unprecise timestamps (like: Q1/2025, meaning first quarter of the year 25). +Secure name:tripkey combinations are autogenerated with each post, but +can be replaced with custom combinations. A valid name:tripkey combination +allows to have a kind of identity that can be used for just one message, +a thread, a sub, or the whole board. Posts can be edited using it as auth. Only one sub is created automatically (main), others can be created by giving a new name for the sub when posting in main. An overboard lets you keep the overview over the latest postings. Also, users can define their own multifeeds, including or excluding subs of their choice. There can be replies to posts, which bumps the original posts to the top -of the sub and the overboard (if enabled). +of the sub and the overboard (if enabled). A sage button can be used to +not bump a thread. An autosage option can be used to prevent megathreads +from blocking the overboard. A (very simple) captcha can be used to protect from some spam. Individual threads, subs or the whole board can be dumped to a json file. The dump of the whole board can be reimported into other instances of @@ -90,17 +97,21 @@ and/or index.php. * 0.63 : changed from hash() to password_hash() for passwords, thanks anon. * 0.64 : fixed a bug in destroy_token(), which would not log you out, - although claiming to do so + although claiming to do so * 0.65 : introduced new function filter(), to get rid of lenghty - substr(preg_replace constructions - fixed a bug in check_free_space() - minor optimizations (like empty instead of isset) + substr(preg_replace constructions + fixed a bug in check_free_space() + minor optimizations (like empty instead of isset) * 0.66 : put in some additional safety for the admin & mod tokens_ * 0.67 : fixed two embarrassing bugs that prevented the admin and the mods - from logging in -* 0.68/0.69/0.70 : various bugfixes and reformatting + from logging in +* 0.70 : various bugfixes and reformatting * 0.71 : introduction of mobile design (thanks, anon !) - +* 0.73 : added features: sage, autosage, timestamps, secure tripcodes, editing + of messages, clickable links for post references, debug interface + for desktop site (to do list for mobile site) + also took functions out of index.php and put them in six smaller + files ### Other features of endboard: @@ -203,12 +214,16 @@ The same for securing your server and making sure it doesn't blab. ### Make directories: -``` mkdir -p /srv/endboard /etc/opt/endboard /var/opt/endboard``` +``` mkdir -p /srv/endboard /etc/opt/endboard /var/opt/endboard /opt/endboard``` ### Distribute files to webroot (from directory of the endboard archive): ``` cp -rv ./srv/* /srv/endboard/``` +### Distribute function files (from directory of the endboard archive): + +``` cp -v ./opt/*.php /opt/endboard/``` + ### Distribute config file to etc (from directory of the endboard archive): ``` cp -v ./etc/config.php /etc/opt/endboard/```