Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Loudbooks authored Dec 6, 2024
1 parent f26e212 commit 9b301cf
Showing 1 changed file with 12 additions and 3 deletions.
15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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:**
<br>
`S3_ACCESS_KEY_ID` - The access key associated with your R2 bucket, S3 bucket, etc.
Expand All @@ -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:**
<br>
`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.
```
Expand Down

0 comments on commit 9b301cf

Please sign in to comment.