conf.sample.php 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295
  1. ;<?php http_response_code(403); /*
  2. ; config file for PrivateBin
  3. ;
  4. ; An explanation of each setting can be find online at https://github.com/PrivateBin/PrivateBin/wiki/Configuration.
  5. [main]
  6. ; (optional) set a project name to be displayed on the website
  7. ; name = "PrivateBin"
  8. ; The full URL, with the domain name and directories that point to the
  9. ; PrivateBin files, including an ending slash (/). This URL is essential to
  10. ; allow Opengraph images to be displayed on social networks.
  11. ; basepath = "https://privatebin.example.com/"
  12. ; enable or disable the discussion feature, defaults to true
  13. discussion = true
  14. ; preselect the discussion feature, defaults to false
  15. opendiscussion = false
  16. ; enable or disable the display of dates & times in the comments, defaults to true
  17. ; Note that internally the creation time will still get tracked in order to sort
  18. ; the comments by creation time, but you can choose not to display them.
  19. ; discussiondatedisplay = false
  20. ; enable or disable the password feature, defaults to true
  21. password = true
  22. ; enable or disable the file upload feature, defaults to false
  23. fileupload = false
  24. ; preselect the burn-after-reading feature, defaults to false
  25. burnafterreadingselected = false
  26. ; which display mode to preselect by default, defaults to "plaintext"
  27. ; make sure the value exists in [formatter_options]
  28. defaultformatter = "plaintext"
  29. ; (optional) set a syntax highlighting theme, as found in css/prettify/
  30. ; syntaxhighlightingtheme = "sons-of-obsidian"
  31. ; size limit per paste or comment in bytes, defaults to 10 Megabytes
  32. sizelimit = 1000000
  33. ; by default PrivateBin use "bootstrap5" template (tpl/bootstrap5.php).
  34. ; Optionally you can enable the template selection menu, which uses
  35. ; a session cookie to store the choice until the browser is closed.
  36. templateselection = false
  37. ; List of available for selection templates when "templateselection" option is enabled
  38. availabletemplates[] = "bootstrap5"
  39. availabletemplates[] = "bootstrap"
  40. availabletemplates[] = "bootstrap-page"
  41. availabletemplates[] = "bootstrap-dark"
  42. availabletemplates[] = "bootstrap-dark-page"
  43. availabletemplates[] = "bootstrap-compact"
  44. availabletemplates[] = "bootstrap-compact-page"
  45. ; set the template your installs defaults to, defaults to "bootstrap5" (tpl/bootstrap5.php), also
  46. ; bootstrap template (tpl/bootstrap.php) and it's variants: "bootstrap-dark", "bootstrap-compact", "bootstrap-page",
  47. ; which can be combined with "-dark" and "-compact" for "bootstrap-dark-page",
  48. ; "bootstrap-compact-page" - previews at:
  49. ; https://privatebin.info/screenshots.html
  50. ; template = "bootstrap5"
  51. ; (optional) info text to display
  52. ; use single, instead of double quotes for HTML attributes
  53. ;info = "More information on the <a href='https://privatebin.info/'>project page</a>."
  54. ; (optional) notice to display
  55. ; notice = "Note: This is a test service: Data may be deleted anytime. Kittens will die if you abuse this service."
  56. ; by default PrivateBin will guess the visitors language based on the browsers
  57. ; settings. Optionally you can enable the language selection menu, which uses
  58. ; a session cookie to store the choice until the browser is closed.
  59. languageselection = false
  60. ; set the language your installs defaults to, defaults to English
  61. ; if this is set and language selection is disabled, this will be the only language
  62. ; languagedefault = "en"
  63. ; (optional) URL shortener address to offer after a new paste is created.
  64. ; It is suggested to only use this with self-hosted shorteners as this will leak
  65. ; the pastes encryption key.
  66. ; urlshortener = "https://shortener.example.com/api?link="
  67. ; (optional) Let users create a QR code for sharing the paste URL with one click.
  68. ; It works both when a new paste is created and when you view a paste.
  69. ; qrcode = true
  70. ; (optional) Let users send an email sharing the paste URL with one click.
  71. ; It works both when a new paste is created and when you view a paste.
  72. ; email = true
  73. ; (optional) IP based icons are a weak mechanism to detect if a comment was from
  74. ; a different user when the same username was used in a comment. It might get
  75. ; used to get the IP of a comment poster if the server salt is leaked and a
  76. ; SHA512 HMAC rainbow table is generated for all (relevant) IPs.
  77. ; Can be set to one these values:
  78. ; "none" / "identicon" / "jdenticon" (default) / "vizhash".
  79. ; icon = "none"
  80. ; Content Security Policy headers allow a website to restrict what sources are
  81. ; allowed to be accessed in its context. You need to change this if you added
  82. ; custom scripts from third-party domains to your templates, e.g. tracking
  83. ; scripts or run your site behind certain DDoS-protection services.
  84. ; Check the documentation at https://content-security-policy.com/
  85. ; Notes:
  86. ; - If you use the bootstrap5 theme, you must change default-src to 'self' to
  87. ; enable display of the svg icons
  88. ; - By default this disallows to load images from third-party servers, e.g. when
  89. ; they are embedded in pastes. If you wish to allow that, you can adjust the
  90. ; policy here. See https://github.com/PrivateBin/PrivateBin/wiki/FAQ#why-does-not-it-load-embedded-images
  91. ; for details.
  92. ; - The 'wasm-unsafe-eval' is used to enable webassembly support (used for zlib
  93. ; compression). You can remove it if compression doesn't need to be supported.
  94. ; - The 'unsafe-inline' style-src is used by Chrome when displaying PDF previews
  95. ; and can be omitted if attachment upload is disabled (which is the default).
  96. ; See https://issues.chromium.org/issues/343754409
  97. ; - To allow displaying PDF previews in Firefox or Chrome, sandboxing must also
  98. ; get turned off. The following CSP allows PDF previews:
  99. ; cspheader = "default-src 'none'; base-uri 'self'; form-action 'none'; manifest-src 'self'; connect-src * blob:; script-src 'self' 'wasm-unsafe-eval'; style-src 'self' 'unsafe-inline'; font-src 'self'; frame-ancestors 'none'; frame-src blob:; img-src 'self' data: blob:; media-src blob:; object-src blob:"
  100. ;
  101. ; The recommended and default used CSP is:
  102. ; cspheader = "default-src 'none'; base-uri 'self'; form-action 'none'; manifest-src 'self'; connect-src * blob:; script-src 'self' 'wasm-unsafe-eval'; style-src 'self'; font-src 'self'; frame-ancestors 'none'; frame-src blob:; img-src 'self' data: blob:; media-src blob:; object-src blob:; sandbox allow-same-origin allow-scripts allow-forms allow-modals allow-downloads"
  103. ; Enable or disable the warning message when the site is served over an insecure
  104. ; connection (insecure HTTP instead of HTTPS), defaults to true.
  105. ; Secure transport methods like Tor and I2P domains are automatically whitelisted.
  106. ; It is **strongly discouraged** to disable this.
  107. ; See https://github.com/PrivateBin/PrivateBin/wiki/FAQ#why-does-it-show-me-an-error-about-an-insecure-connection for more information.
  108. ; httpwarning = true
  109. ; Pick compression algorithm or disable it. Only applies to pastes/comments
  110. ; created after changing the setting.
  111. ; Can be set to one these values: "none" / "zlib" (default).
  112. ; compression = "zlib"
  113. [expire]
  114. ; expire value that is selected per default
  115. ; make sure the value exists in [expire_options]
  116. default = "1week"
  117. [expire_options]
  118. ; Set each one of these to the number of seconds in the expiration period,
  119. ; or 0 if it should never expire
  120. 5min = 300
  121. 10min = 600
  122. 1hour = 3600
  123. 1day = 86400
  124. 1week = 604800
  125. ; Well this is not *exactly* one month, it's 30 days:
  126. 1month = 2592000
  127. 1year = 31536000
  128. never = 0
  129. [formatter_options]
  130. ; Set available formatters, their order and their labels
  131. plaintext = "Plain Text"
  132. syntaxhighlighting = "Source Code"
  133. markdown = "Markdown"
  134. [traffic]
  135. ; time limit between calls from the same IP address in seconds
  136. ; Set this to 0 to disable rate limiting.
  137. limit = 10
  138. ; (optional) Set IPs addresses (v4 or v6) or subnets (CIDR) which are exempted
  139. ; from the rate-limit. Invalid IPs will be ignored. If multiple values are to
  140. ; be exempted, the list needs to be comma separated. Leave unset to disable
  141. ; exemptions.
  142. ; exempted = "1.2.3.4,10.10.10/24"
  143. ; (optional) If you want only some source IP addresses (v4 or v6) or subnets
  144. ; (CIDR) to be allowed to create pastes, set these here. Invalid IPs will be
  145. ; ignored. If multiple values are to be exempted, the list needs to be comma
  146. ; separated. Leave unset to allow anyone to create pastes.
  147. ; creators = "1.2.3.4,10.10.10/24"
  148. ; (optional) if your website runs behind a reverse proxy or load balancer,
  149. ; set the HTTP header containing the visitors IP address, i.e. X_FORWARDED_FOR
  150. ; header = "X_FORWARDED_FOR"
  151. [purge]
  152. ; minimum time limit between two purgings of expired pastes, it is only
  153. ; triggered when pastes are created
  154. ; Set this to 0 to run a purge every time a paste is created.
  155. limit = 300
  156. ; maximum amount of expired pastes to delete in one purge
  157. ; Set this to 0 to disable purging. Set it higher, if you are running a large
  158. ; site
  159. batchsize = 10
  160. [model]
  161. ; name of data model class to load and directory for storage
  162. ; the default model "Filesystem" stores everything in the filesystem
  163. class = Filesystem
  164. [model_options]
  165. dir = PATH "data"
  166. ;[model]
  167. ; example of a Google Cloud Storage configuration
  168. ;class = GoogleCloudStorage
  169. ;[model_options]
  170. ;bucket = "my-private-bin"
  171. ;prefix = "pastes"
  172. ;uniformacl = false
  173. ;[model]
  174. ; example of DB configuration for MySQL
  175. ;class = Database
  176. ;[model_options]
  177. ;dsn = "mysql:host=localhost;dbname=privatebin;charset=UTF8"
  178. ;tbl = "privatebin_" ; table prefix
  179. ;usr = "privatebin"
  180. ;pwd = "Z3r0P4ss"
  181. ;opt[12] = true ; PDO::ATTR_PERSISTENT
  182. ;[model]
  183. ; example of DB configuration for SQLite
  184. ;class = Database
  185. ;[model_options]
  186. ;dsn = "sqlite:" PATH "data/db.sq3"
  187. ;usr = null
  188. ;pwd = null
  189. ;opt[12] = true ; PDO::ATTR_PERSISTENT
  190. ;[model]
  191. ; example of DB configuration for PostgreSQL
  192. ;class = Database
  193. ;[model_options]
  194. ;dsn = "pgsql:host=localhost;dbname=privatebin"
  195. ;tbl = "privatebin_" ; table prefix
  196. ;usr = "privatebin"
  197. ;pwd = "Z3r0P4ss"
  198. ;opt[12] = true ; PDO::ATTR_PERSISTENT
  199. ;[model]
  200. ; example of S3 configuration for Rados gateway / CEPH
  201. ;class = S3Storage
  202. ;[model_options]
  203. ;region = ""
  204. ;version = "2006-03-01"
  205. ;endpoint = "https://s3.my-ceph.invalid"
  206. ;use_path_style_endpoint = true
  207. ;bucket = "my-bucket"
  208. ;accesskey = "my-rados-user"
  209. ;secretkey = "my-rados-pass"
  210. ;[model]
  211. ; example of S3 configuration for AWS
  212. ;class = S3Storage
  213. ;[model_options]
  214. ;region = "eu-central-1"
  215. ;version = "latest"
  216. ;bucket = "my-bucket"
  217. ;accesskey = "access key id"
  218. ;secretkey = "secret access key"
  219. ;[model]
  220. ; example of S3 configuration for AWS using its SDK default credential provider chain
  221. ; if relying on environment variables, the AWS SDK will look for the following:
  222. ; - AWS_ACCESS_KEY_ID
  223. ; - AWS_SECRET_ACCESS_KEY
  224. ; - AWS_SESSION_TOKEN (if needed)
  225. ; for more details, see https://docs.aws.amazon.com/sdk-for-php/v3/developer-guide/guide_credentials.html#default-credential-chain
  226. ;class = S3Storage
  227. ;[model_options]
  228. ;region = "eu-central-1"
  229. ;version = "latest"
  230. ;bucket = "my-bucket"
  231. ;[yourls]
  232. ; When using YOURLS as a "urlshortener" config item:
  233. ; - By default, "urlshortener" will point to the YOURLS API URL, with or without
  234. ; credentials, and will be visible in public on the PrivateBin web page.
  235. ; Only use this if you allow short URL creation without credentials.
  236. ; - Alternatively, using the parameters in this section ("signature" and
  237. ; "apiurl"), "urlshortener" needs to point to the base URL of your PrivateBin
  238. ; instance with "?shortenviayourls&link=" appended. For example:
  239. ; urlshortener = "${basepath}?shortenviayourls&link="
  240. ; This URL will in turn call YOURLS on the server side, using the URL from
  241. ; "apiurl" and the "access signature" from the "signature" parameters below.
  242. ; (optional) the "signature" (access key) issued by YOURLS for the using account
  243. ; signature = ""
  244. ; (optional) the URL of the YOURLS API, called to shorten a PrivateBin URL
  245. ; apiurl = "https://yourls.example.com/yourls-api.php"
  246. ;[sri]
  247. ; Subresource integrity (SRI) hashes used in template files. Uncomment and set
  248. ; these for all js files used. See:
  249. ; https://github.com/PrivateBin/PrivateBin/wiki/FAQ#user-content-how-to-make-privatebin-work-when-i-have-changed-some-javascript-files
  250. ;js/privatebin.js = "sha512-[…]"