support multiple languages for about_text
[coquelicot.git] / conf / settings-default.yml
index f713b53..d4d5f39 100644 (file)
+# Default settings for Coquelicot
+# ===============================
+#
+# Coquelicot is a "one-click" file sharing web application with a specific
+# focus on protecting users' privacy.
+#
+# This file contains the default settings and their meaning.
+#
+# These settings are only here for illustration purpose. Site specific
+# configuration only needs to specify the ones that need to be changed.
+
+# Maximum size allowed for uploaded files
+# (in bytes)
+#
+#   Default: 5242880 = 5 * 1024 * 1024
+#
+max_file_size: 5242880
+
+# Default expiration time (if unspecified by users)
+# (in minutes)
+#
 default_expire: 60
-# 43200 == 60 * 24 * 30 == 1 month
+
+# Maximum expiration time that can be set by users
+# (in minutes)
+#
+#   Default: 43200 = 60 * 24 * 30 ≈ 1 month
+#
 maximum_expire: 43200
+
+# Time before complete cleanup of an expired file
+# (in minutes)
+#
+#   Once a file is expired either because of time or because
+#   it was set for only one download, Coquelicot will scrape
+#   the file content, but keep an empty file around to display
+#   a “Too late” message instead of the default “Not found”.
+#
+#   This setting will influence how long will users see the
+#   first message instead of the second in case they try to
+#   access an expired link.
+#
+#   Default: 10080 = 60 * 24 * 7 ≈ 1 week
+#
 gone_period: 10080
+
+# Number of characters in generated filenames
+#
+#   URL to download files looks like:
+#     https://example.org/dhut7f73u2hiwwifwyrs-gs5wj3ixjheg6dg7
+#     (when no password has been specified)
+#   or:
+#     https://example.org/dhut7f73u2hiwwifwyrs
+#
+#   This setting controls the first set of characters.
+#
 filename_length: 20
+
+# Number of characters in generated passwords
+#
+#   When no password is specified URL looks like:
+#     https://example.org/dhut7f73u2hiwwifwyrs-gs5wj3ixjheg6dg7
+#
+#   This setting controls the second set of characters. The same
+#   code is also used when using the 'Generate password…' link.
+#
 random_pass_length: 16
-depot_path: './files'
+
+# Directory in which Coquelicot will write its files
+#
+depot_path: "./files"
+
+# Text to display on top of the upload form
+#
+#   This is indexed by locale code to support multiple languages.
+#   It will fallback to English for unspecified languages.
+about_text:
+  en: ""
+
+# Path to an additional stylesheet
+additional_css: ""
+
+# Path to the PID file of the web server
+pid: "./tmp/coquelicot.pid"
+
+# Path to Coquelicot log file
+#
+#   Set to an empty string to disable logging.
+#
+log: "./tmp/coquelicot.log"
+
+# Listening addresses of the web server
+#
+#   Each entries may be a port number for a TCP port, an “IP_ADDRESS:PORT” for
+#   TCP listeners or a pathname for UNIX domain sockets.
+#
+#   Examples:
+#    - "51161"                 # listen to port 51161 on all TCP interfaces
+#    - "127.0.0.1:51161"       # listen to port 51161 on the loopback interface
+#    - "/tmp/.coquelicot.sock" # listen on the given Unix domain socket
+#    - "[::1]:51161"           # listen to port 51161 on the IPv6 loopback interface
+#
+listen:
+ - "127.0.0.1:51161"
+
+# Display debugging data in the browser when an exception is raised
+#
+#   This should only be turned on when doing development.
+show_exceptions: false
+
+# Authentication method
+#
+#   Please have look at `conf/settings-simplepass.yml` and
+#   `conf/settings-imap.yml` for more details.
+#
+# The default password is 'test'.
 authentication_method:
-  name: 'simplepass'
-  upload_password: 'a94a8fe5ccb19ba61c4c0873d391e987982fbbd3'          
+  name: "simplepass"
+  upload_password: "a94a8fe5ccb19ba61c4c0873d391e987982fbbd3"