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