improve settings documentation
[coquelicot.git] / conf / settings-default.yml
1 # Default settings for Coquelicot
2 # ===============================
3 #
4 # Coquelicot is a "one-click" file sharing web application with a specific
5 # focus on protecting users' privacy.
6 #
7 # This file contains the default settings and their meaning.
8 #
9 # These settings are only here for illustration purpose. Site specific
10 # configuration only needs to specify the ones that need to be changed.
11
12 # Base URL for Coquelicot
13 #
14 #   It should end with a '/'.
15 #
16 #   When empty, it will be computed dynamically using upcoming requests.
17 #
18 url: ""
19
20 # Default expiration time (if unspecified by users)
21 # (in minutes)
22 #
23 default_expire: 60
24
25 # Maximum expiration time that can be set by users
26 # (in minutes)
27 #
28 #   Default: 43200 = 60 * 24 * 30 ≈ 1 month
29 #
30 maximum_expire: 43200
31
32 # Time before complete cleanup of an expired file
33 # (in minutes)
34 #
35 #   Once a file is expired either because of time or because
36 #   it was set for only one download, Coquelicot will scrape
37 #   the file content, but keep an empty file around to display
38 #   a “Too late” message instead of the default “Not found”.
39 #
40 #   This setting will influence how long will users see the
41 #   first message instead of the second in case they try to
42 #   access an expired link.
43 #
44 #   Default: 10080 = 60 * 24 * 7 ≈ 1 week
45 #
46 gone_period: 10080
47
48 # Number of characters in generated filenames
49 #
50 #   URL to download files looks like:
51 #     https://example.org/dhut7f73u2hiwwifwyrs-gs5wj3ixjheg6dg7
52 #     (when no password has been specified)
53 #   or:
54 #     https://example.org/dhut7f73u2hiwwifwyrs
55 #
56 #   This setting controls the first set of characters.
57 #
58 filename_length: 20
59
60 # Number of characters in generated passwords
61 #
62 #   When no password is specified URL looks like:
63 #     https://example.org/dhut7f73u2hiwwifwyrs-gs5wj3ixjheg6dg7
64 #
65 #   This setting controls the second set of characters. The same
66 #   code is also used when using the 'Generate password…' link.
67 #
68 random_pass_length: 16
69
70 # Directory in which Coquelicot will write its files
71 #
72 depot_path: "./files"
73
74 # Text to display on top of the upload form
75 #
76 about_text: ""
77
78 # Path to an additional stylesheet
79 additional_css: ""
80
81 # Authentication method
82 #
83 #   Please have look at `conf/settings-simplepass.yml` and
84 #   `conf/settings-imap.yml` for more details.
85 #
86 # The default password is 'test'.
87 authentication_method:
88   name: "simplepass"
89   upload_password: "a94a8fe5ccb19ba61c4c0873d391e987982fbbd3"