From 6ddd97e1c39f55fe60fca093ca4fe610eca6d462 Mon Sep 17 00:00:00 2001 From: mjfernez Date: Wed, 25 Aug 2021 20:05:00 -0400 Subject: Clarify siteconfig This clarifies what the MAIN_SITE_DIRS option means since one might read it to mean you can put your directories anywhere. Not so, you can only pick which dirs are displayed with that option. Also recommends to not use the secret key unless needed (for what reason, I don't know). --- siteconfig.py | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) (limited to 'siteconfig.py') diff --git a/siteconfig.py b/siteconfig.py index 8dbe006..3a0229f 100644 --- a/siteconfig.py +++ b/siteconfig.py @@ -1,9 +1,10 @@ class siteconfig: # REQUIRED SETTINGS# - DOMAIN = "example.net" # Your domain name, or site title - HOME_TITLE = "WELCOME" # "HELLO WORLD!" - LINKS_FILE = ".links" # ".lnx" - DESC_FILE = ".description" # ".desc`" + + DOMAIN = "example.net" # Your site here! + HOME_TITLE = "WELCOME" # "HELLO WORLD!" + LINKS_FILE = ".links" # ".lnx" if you like + DESC_FILE = ".description" # ".desc" DEFAULT_MIMETYPE = "application/octet-stream" # "text/plain" MIMETYPES = {} @@ -13,7 +14,12 @@ class siteconfig: MIMETYPES.update({ext: mime}) # OPTIONAL SETTINGS # - # Remove 'None' to add custom values + + # Be default, ALL directories in the site toolbar are contained in + # ./templates/site/. You can change this to only specific directories, but + # these still have to be in ./templates/site MAIN_SITE_DIRS = None # ["dir1", "dir2", "dir3"] - # b"\xca\x05\x80\xa3|\xdbh@\xec<\xcd\x19\xf4\nRN:)\x13\x917|km\xb0'>'\x1d&G\xe8" - SECRET_KEY = None + # Set a custom secret key. If not set, it will be generated + # Most of the time, you don't need to set this! + SECRET_KEY = None # Something random. + -- cgit v1.2.3