Infra-Mirrors/PrivateBin
1
0
Fork 0
mirror of https://github.com/PrivateBin/PrivateBin.git synced 2024-10-01 01:26:10 -04:00
Code Issues Packages Projects Releases Wiki Activity

update documentation

Browse Source 
- clarify all template options & link to previews
- document new ctype extension requirement
This commit is contained in:
El RIDO 2024-04-01 14:34:23 +02:00
parent 3bc09ed561
commit aae3ea7cbf
No known key found for this signature in database
GPG Key ID: 0F5C940A6BD81F92
2 changed files with 9 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
cfg/conf.sample.php
View File

@ -37,9 +37,12 @@ defaultformatter = "plaintext"
; size limit per paste or comment in bytes, defaults to 10 Mebibytes ; size limit per paste or comment in bytes, defaults to 10 Mebibytes
sizelimit = 10485760 sizelimit = 10485760
; template to include, default is "bootstrap" (tpl/bootstrap.php) ; template to include, default is "bootstrap" (tpl/bootstrap.php), also
; Also available is a dark version ("bootstrap-dark",) and ; available are "page" (tpl/page.php), the classic ZeroBin style and several
; a theme that resembles the classic ZeroBin style ("page".) ; bootstrap variants: "bootstrap-dark", "bootstrap-compact", "bootstrap-page",
; which can be combined with "-dark" and "-compact" for "bootstrap-dark-page"
; and finally "bootstrap-compact-page" - previews at:
; https://privatebin.info/screenshots.html
template = "bootstrap" template = "bootstrap"
; (optional) info text to display ; (optional) info text to display
@ -242,7 +245,7 @@ dir = PATH "data"
; - AWS_ACCESS_KEY_ID ; - AWS_ACCESS_KEY_ID
; - AWS_SECRET_ACCESS_KEY ; - AWS_SECRET_ACCESS_KEY
; - AWS_SESSION_TOKEN (if needed) ; - AWS_SESSION_TOKEN (if needed)
; for more details, see https://docs.aws.amazon.com/sdk-for-php/v3/developer-guide/guide_credentials.html#default-credential-chain ; for more details, see https://docs.aws.amazon.com/sdk-for-php/v3/developer-guide/guide_credentials.html#default-credential-chain
;class = S3Storage ;class = S3Storage
;[model_options] ;[model_options]
;region = "eu-central-1" ;region = "eu-central-1"
@ -264,4 +267,4 @@ dir = PATH "data"
; (optional) the "signature" (access key) issued by YOURLS for the using account ; (optional) the "signature" (access key) issued by YOURLS for the using account
; signature = "" ; signature = ""
; (optional) the URL of the YOURLS API, called to shorten a PrivateBin URL ; (optional) the URL of the YOURLS API, called to shorten a PrivateBin URL
; apiurl = "https://yourls.example.com/yourls-api.php" ; apiurl = "https://yourls.example.com/yourls-api.php"

1
doc/Installation.md
View File

@ -22,6 +22,7 @@ for more information.
### Minimal Requirements ### Minimal Requirements
- PHP version 7.3 or above - PHP version 7.3 or above
- ctype extension
- GD extension (when using identicon or vizhash icons, jdenticon works without it) - GD extension (when using identicon or vizhash icons, jdenticon works without it)
- zlib extension - zlib extension
- some disk space or a database supported by [PDO](https://php.net/manual/book.pdo.php) - some disk space or a database supported by [PDO](https://php.net/manual/book.pdo.php)