From b87921c8118b879e142c23960913ca089720a1bc Mon Sep 17 00:00:00 2001 From: "Stanislav N. aka pztrn" Date: Sun, 14 Aug 2022 16:51:17 +0500 Subject: [PATCH] README update. --- README.md | 35 ++++++++++++++++++++++++++++++++++- 1 file changed, 34 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6b52410..f0d25c8 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,8 @@ Easy-to-use-and-install pastebin software written in Go. No bells or whistles, n **Please, use [my gitea](https://code.pztrn.name/apps/fastpastebin) for bug reporting. All other places are mirrors!** +Also, [join Matrix room](https://matrix.to/#/%23fastpastebin:pztrn.online?via=matrix.org) for near-realtime chat. + ## Current functionality * Create and view public and private pastes. @@ -23,11 +25,34 @@ Easy-to-use-and-install pastebin software written in Go. No bells or whistles, n Just issue: ```bash -CGO_ENABLED=0 go install go.dev.pztrn.name/fastpastebin/cmd/fastpastebin@latest +CGO_ENABLED=0 go install go.dev.pztrn.name/fastpastebin/cmd/fastpastebin@VERSION ``` +Replace `VERSION` with a [tag of your choice](https://code.pztrn.name/apps/fastpastebin/releases). + This command can be used to update Fast Paste Bin. +Also Fast Paste Bin is dockerized, see [here](https://code.pztrn.name/apps/-/packages/container/fastpastebin) for instructions. + +Compose file with resources limits, as used by me: + +```yaml +--- +version: "2.4" + +services: + fastpastebin: + restart: always + image: code.pztrn.name/apps/fastpastebin:0.4.1 + volumes: + - "./fastpastebin.yaml:/app/fastpastebin.yaml" + ports: + - "25544:25544" + cpus: 2 + mem_limit: 1G + memswap_limit: 0 +``` + ## Configuration Take a look at [example configuration file](examples/fastpastebin.yaml.dist) which contains all supported options and their descriptions. @@ -36,6 +61,14 @@ Configuration file position is irrelevant, there is no hardcoded paths where Fas ## Developing +### Branching, versions, etc + +There is a `develop` branch which represents current development state. **All new commits (by me) and merge requests (by others) should go to that branch**. + +Branch `master` represents "latest version" state and always stable. + +### Code + Use linters, formatters, etc. VSCode with Go plugin is recommended for developing as it will perform most of linting-formatting actions automagically.