From aae3ea7cbfa07f70b2a2ea421b09af8581aeac6a Mon Sep 17 00:00:00 2001 From: El RIDO Date: Mon, 1 Apr 2024 14:34:23 +0200 Subject: [PATCH] update documentation - clarify all template options & link to previews - document new ctype extension requirement --- cfg/conf.sample.php | 13 ++++++++----- doc/Installation.md | 1 + 2 files changed, 9 insertions(+), 5 deletions(-) diff --git a/cfg/conf.sample.php b/cfg/conf.sample.php index 141888f2..b128bf48 100644 --- a/cfg/conf.sample.php +++ b/cfg/conf.sample.php @@ -37,9 +37,12 @@ defaultformatter = "plaintext" ; size limit per paste or comment in bytes, defaults to 10 Mebibytes sizelimit = 10485760 -; template to include, default is "bootstrap" (tpl/bootstrap.php) -; Also available is a dark version ("bootstrap-dark",) and -; a theme that resembles the classic ZeroBin style ("page".) +; template to include, default is "bootstrap" (tpl/bootstrap.php), also +; available are "page" (tpl/page.php), the classic ZeroBin style and several +; 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" ; (optional) info text to display @@ -242,7 +245,7 @@ dir = PATH "data" ; - AWS_ACCESS_KEY_ID ; - AWS_SECRET_ACCESS_KEY ; - 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 ;[model_options] ;region = "eu-central-1" @@ -264,4 +267,4 @@ dir = PATH "data" ; (optional) the "signature" (access key) issued by YOURLS for the using account ; signature = "" ; (optional) the URL of the YOURLS API, called to shorten a PrivateBin URL -; apiurl = "https://yourls.example.com/yourls-api.php" \ No newline at end of file +; apiurl = "https://yourls.example.com/yourls-api.php" diff --git a/doc/Installation.md b/doc/Installation.md index 77f79fbb..b09de9e1 100644 --- a/doc/Installation.md +++ b/doc/Installation.md @@ -22,6 +22,7 @@ for more information. ### Minimal Requirements - PHP version 7.3 or above +- ctype extension - GD extension (when using identicon or vizhash icons, jdenticon works without it) - zlib extension - some disk space or a database supported by [PDO](https://php.net/manual/book.pdo.php)