aboutsummaryrefslogtreecommitdiffstats
path: root/siteconfig.py
blob: 412dfce5081f201bb28996840368a49a163d26f5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
"""
siteconfig.py - user editable configuration file
"""


class siteconfig:
    # REQUIRED SETTINGS#

    DOMAIN = "example.net"  # Your site here!
    HOME_TITLE = "WELCOME"  # Goes right under
    # your site
    LINKS_FILE = ".links"  # ".lnx" if you like
    DESC_FILE = ".description"  # ".desc"
    DEFAULT_MIMETYPE = "application/octet-stream"
    # ^This usually prompts a browser to download a file if the mime
    # type is unknown. A good alternative might be "text/plain"

    # Add your desired mimetypes to the csv file
    MIMETYPES = {}
    with open('mimetypes.csv') as f:
        for line in f.readlines():
            ext, mime = line.strip().split(',')
            MIMETYPES.update({ext: mime})

    # OPTIONAL SETTINGS #

    # 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"]

    # 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.

    # Option for Flask Compress
    # see here https://pypi.org/project/Flask-Compress/
    COMPRESS_MIMETYPES = list(MIMETYPES.values())

    # Option for Flask Caching
    # https://flask-caching.readthedocs.io/en/latest/#configuring-flask-caching
    cache_config = {
        'CACHE_TYPE' : "SimpleCache",
        'CACHE_DEFAULT_TIMEOUT' : 300,
        # You should only fill ONE of the sections below
        # uswgi
        'CACHE_UWSGI_NAME' : None,
        ##
        # memcache
        'CACHE_MEMCACHED_SERVERS' : None,
        'CACHE_MEMCACHED_USERNAME' : None,
        'CACHE_MEMCACHED_PASSWORD' : None,
        ##
        # redis
        'CACHE_REDIS_HOST' : None,
        'CACHE_REDIS_PORT' : None,
        'CACHE_REDIS_PASSWORD' : None,
        'CACHE_REDIS_DB' : None,
        'CACHE_REDIS_URL' : None,
        'CACHE_REDIS_SENTINELS' : None,
        'CACHE_REDIS_SENTINEL_MASTER' : None,
        'CACHE_REDIS_CLUSTER' : None,
        ##
        # filesystem
        'CACHE_DIR' : None,
        # add more options as needed from the URL above
    }