summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorKatolaZ <katolaz@freaknet.org>2017-06-30 23:15:36 +0100
committerKatolaZ <katolaz@freaknet.org>2017-06-30 23:15:36 +0100
commitee3dc59322eb3a366f3594261491381db5084110 (patch)
treefa3a98639cf8c38f80c42fe00f1f8abb0562d200 /README.md
parentcfc67a824600be8d522c23c108d6333fca6b0359 (diff)
Added max_size in the configuration file
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 11 insertions, 2 deletions
diff --git a/README.md b/README.md
index b3868b7..dceb7e4 100644
--- a/README.md
+++ b/README.md
@@ -13,8 +13,17 @@ The unique ID of a paste is obtained from the SHA256 of the
concatenation of title, time, and content. Rendering is minimal, but
can be enhanced.
+`binit` is currently configured through a simple key=value
+configuration file. The available options are:
+
+* host (the hostname to listen on)
+* port (the port to bind)
+* paste\_dir (the folder where pastes are kept)
+* templ\_dir (the folder where HTML files and templates are kept)
+* max_size (the maximum allowed length of a paste, in bytes. Larger
+ pastes will be trimmed to that length)
+
+
### TODO
-* Check maximum paste length
-* Add a config file (hostname, port, pastedir)
* Add a simple template system