Fix name-typo in NEWS
[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 focus
5 # 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 # Maximum size allowed for uploaded files
13 # (in bytes)
14 #
15 #   Default: 5242880 = 5 * 1024 * 1024
16 #
17 max_file_size: 5242880
18
19 # Default expiration time (if unspecified by users)
20 # (in minutes)
21 #
22 #   Default: 1440 = 60 * 24 ≈ 1 day
23 #
24 default_expire: 1440
25
26 # Maximum expiration time that can be set by users
27 # (in minutes)
28 #
29 #   Default: 43200 = 60 * 24 * 30 ≈ 1 month
30 #
31 maximum_expire: 43200
32
33 # Time before complete cleanup of an expired file
34 # (in minutes)
35 #
36 #   Once a file is expired either because of time or because
37 #   it was set for only one download, Coquelicot will scrape
38 #   the file content, but keep an empty file around to display
39 #   a “Too late” message instead of the default “Not found”.
40 #
41 #   This setting will influence how long will users see the
42 #   first message instead of the second in case they try to
43 #   access an expired link.
44 #
45 #   Default: 10080 = 60 * 24 * 7 ≈ 1 week
46 #
47 gone_period: 10080
48
49 # Number of characters in generated filenames
50 #
51 #   URL to download files looks like:
52 #     https://example.org/dhut7f73u2hiwwifwyrs-gs5wj3ixjheg6dg7
53 #     (when no password has been specified)
54 #   or:
55 #     https://example.org/dhut7f73u2hiwwifwyrs
56 #
57 #   This setting controls the first set of characters.
58 #
59 filename_length: 20
60
61 # Number of characters in generated passwords
62 #
63 #   When no password is specified URL looks like:
64 #     https://example.org/dhut7f73u2hiwwifwyrs-gs5wj3ixjheg6dg7
65 #
66 #   This setting controls the second set of characters. The same
67 #   code is also used when using the 'Generate password…' link.
68 #
69 random_pass_length: 16
70
71 # Directory in which Coquelicot will write the stored files
72 #
73 depot_path: "./files"
74
75 # Directory in which Coquelicot will write cache files. The content is only
76 # required to speed up operations and does not have to be stored permanently.
77 #
78 cache_path: "./tmp/cache"
79
80 # Text to display on top of the upload form
81 #
82 #   This is indexed by locale code to support multiple languages.
83 #   It will fallback to English for unspecified languages.
84 about_text:
85   en: ""
86
87 # Path to an additional stylesheet
88 additional_css: ""
89
90 # Path to the PID file of the web server
91 pid: "./tmp/coquelicot.pid"
92
93 # Path to Coquelicot log file
94 #
95 #   Set to an empty string to disable logging.
96 #
97 log: "./tmp/coquelicot.log"
98
99 # Listening addresses of the web server
100 #
101 #   Each entries may be a port number for a TCP port, an “IP_ADDRESS:PORT” for
102 #   TCP listeners or a pathname for UNIX domain sockets.
103 #
104 #   Examples:
105 #    - "51161"                 # listen to port 51161 on all TCP interfaces
106 #    - "127.0.0.1:51161"       # listen to port 51161 on the loopback interface
107 #    - "/tmp/.coquelicot.sock" # listen on the given Unix domain socket
108 #    - "[::1]:51161"           # listen to port 51161 on the IPv6 loopback interface
109 #
110 listen:
111  - "127.0.0.1:51161"
112
113 # Path used URL to access the application.
114 #
115 #   As an example, if you want to make Coquelicot accessible from
116 #   https://example.org/dl/ set `path` to `/dl`.
117 #
118 path: "/"
119
120 # Display debugging data in the browser when an exception is raised
121 #
122 #   This should only be turned on when doing development.
123 show_exceptions: false
124
125 # Authentication method
126 #
127 #   Please have a look at `conf/settings-simplepass.yml`,
128 #   `conf/settings-imap.yml` and `conf/settings-ldap.yml` for more details.
129 #
130 # The default password is 'test'.
131 authentication_method:
132   name: "simplepass"
133   upload_password: "a94a8fe5ccb19ba61c4c0873d391e987982fbbd3"