initial docs and environment setup for a chan style messages management system

This commit is contained in:
shockrah 2020-08-22 19:47:50 -07:00
parent fe05baac41
commit bbcea10237
3 changed files with 31 additions and 0 deletions

2
chan-like/.gitignore vendored Normal file
View File

@ -0,0 +1,2 @@
bin/
lib/

8
chan-like/pyvenv.cfg Normal file
View File

@ -0,0 +1,8 @@
home = /usr
implementation = CPython
version_info = 3.8.5.final.0
virtualenv = 20.0.20
include-system-site-packages = false
base-prefix = /usr
base-exec-prefix = /usr
base-executable = /usr/bin/python3

21
chan-like/readme.md Normal file
View File

@ -0,0 +1,21 @@
# Chan-Like Addon
A simple plugin which can be used to give Freechat a more _chan-like_ experience where messages are not saved forever.
This is basically another chronjob script that will execute every few minutes or so, removing old content unles otherwise specified.
## Options and what they do
* time-out [VALUE] : sets an expiration timer for messages (on the order of days)
Example : `--time-out 30` messages older than 30 days will be deletede
* message-limit [VALUE] : sets the max number of messages allowed in each channel
Example : `--message-limit 1000` after 1000 messages the oldest message will be removed to keep the amount of messages to around 1000.
NOTE : this creates a new process if --no-poll is specified
* --no-poll : Opt out of polling and listen for changes in the database