From 9b301cfadb97e95966ecb8fa5a1bd36f7f814fb4 Mon Sep 17 00:00:00 2001 From: Loudbook Date: Fri, 6 Dec 2024 16:31:27 -0500 Subject: [PATCH] Update README.md --- README.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 35df8da..06a62ef 100644 --- a/README.md +++ b/README.md @@ -33,8 +33,8 @@ services: ports: - "3000:3000" environment: - - TITLE=PasteBook - - DESCRIPTION=PasteBook is an aesthetic, effortless way to share your blocks of text, and respects your privacy by automatically deleting your pastes. + - TITLE= + - DESCRIPTION= depends_on: - backend networks: @@ -62,7 +62,10 @@ networks: driver: bridge ``` ### Configuration -All of the following values must be changed. +> [!CAUTION] +> Do not change any prefilled configurations other than ones listen below. You will break things. + +**Required configurations:**
`S3_ACCESS_KEY_ID` - The access key associated with your R2 bucket, S3 bucket, etc. @@ -71,6 +74,12 @@ All of the following values must be changed. `S3_ENDPOINT` - The endpoint associated with your R2 bucket, S3 bucket, etc. +**Optional configurations:** +
+`TITLE` - The title to be used around PasteBook. + +`DESCRIPTION` - The description to be used in embeds and on the home page of PasteBook. + ### Creation Run the following. ```