Compare commits
No commits in common. "HEAD" and "v0.4.1" have entirely different histories.
35
README.md
35
README.md
@ -6,8 +6,6 @@ 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!**
|
**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
|
## Current functionality
|
||||||
|
|
||||||
* Create and view public and private pastes.
|
* Create and view public and private pastes.
|
||||||
@ -25,34 +23,11 @@ Also, [join Matrix room](https://matrix.to/#/%23fastpastebin:pztrn.online?via=ma
|
|||||||
Just issue:
|
Just issue:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
CGO_ENABLED=0 go install go.dev.pztrn.name/fastpastebin/cmd/fastpastebin@VERSION
|
CGO_ENABLED=0 go install go.dev.pztrn.name/fastpastebin/cmd/fastpastebin@latest
|
||||||
```
|
```
|
||||||
|
|
||||||
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.
|
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
|
## Configuration
|
||||||
|
|
||||||
Take a look at [example configuration file](examples/fastpastebin.yaml.dist) which contains all supported options and their descriptions.
|
Take a look at [example configuration file](examples/fastpastebin.yaml.dist) which contains all supported options and their descriptions.
|
||||||
@ -61,14 +36,6 @@ Configuration file position is irrelevant, there is no hardcoded paths where Fas
|
|||||||
|
|
||||||
## Developing
|
## 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
|
Use linters, formatters, etc. VSCode with Go plugin is recommended for developing as it will perform most of linting-formatting
|
||||||
actions automagically.
|
actions automagically.
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user