fastpastebin/README.md

91 lines
2.8 KiB
Markdown
Raw Normal View History

2018-04-30 18:42:17 +05:00
# Fast Pastebin
2022-08-14 14:49:31 +05:00
[![Build Status](https://ci.code.pztrn.name/api/badges/apps/fastpastebin/status.svg)](https://ci.code.pztrn.name/apps/fastpastebin)
2020-02-29 23:51:23 +05:00
Easy-to-use-and-install pastebin software written in Go. No bells or whistles, no websockets and even NO JAVASCRIPT!
2018-05-01 14:41:36 +05:00
2022-08-14 14:49:31 +05:00
**Please, use [my gitea](https://code.pztrn.name/apps/fastpastebin) for bug reporting. All other places are mirrors!**
2022-08-14 16:51:17 +05:00
Also, [join Matrix room](https://matrix.to/#/%23fastpastebin:pztrn.online?via=matrix.org) for near-realtime chat.
2020-02-29 23:51:23 +05:00
## Current functionality
2018-05-01 14:41:36 +05:00
* Create and view public and private pastes.
2018-05-01 14:41:36 +05:00
* Syntax highlighting.
2018-05-17 22:43:15 +05:00
* Pastes expiration.
* Passwords for pastes.
2019-10-13 14:50:11 +05:00
* Multiple storage backends. Currently: ``flatfiles``, ``mysql`` and ``postgresql``.
2018-05-01 14:41:36 +05:00
2020-02-29 23:51:23 +05:00
## Caveats
2018-05-01 14:41:36 +05:00
* Not known at this moment.
2020-02-29 23:51:23 +05:00
## Installation and updating
Just issue:
2020-02-29 23:51:23 +05:00
```bash
2022-08-14 16:51:17 +05:00
CGO_ENABLED=0 go install go.dev.pztrn.name/fastpastebin/cmd/fastpastebin@VERSION
```
2022-08-14 16:51:17 +05:00
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.
2022-08-14 16:51:17 +05:00
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
```
2020-02-29 23:51:23 +05:00
## Configuration
2020-02-29 23:51:23 +05:00
Take a look at [example configuration file](examples/fastpastebin.yaml.dist) which contains all supported options and their descriptions.
Configuration file position is irrelevant, there is no hardcoded paths where Fast Paste Bin looking for it's configuration. Use ``FASTPASTEBIN_CONFIG`` environment variable to specify path.
2020-02-29 23:51:23 +05:00
## Developing
2022-08-14 16:51:17 +05:00
### 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
2022-08-14 14:49:31 +05:00
Use linters, formatters, etc. VSCode with Go plugin is recommended for developing as it will perform most of linting-formatting
actions automagically.
2022-08-14 14:49:31 +05:00
Also, Sublime Text with LSP-gopls will also work just fine.
2022-08-14 14:49:31 +05:00
Try to follow [Go's code review comments](https://github.com/golang/go/wiki/CodeReviewComments) with few exceptions:
2020-02-29 23:51:23 +05:00
* We're not forcing any limits on line length for code, only for comments, they should be 72-76 chars long.
2020-02-29 23:51:23 +05:00
## ToDo
2020-02-29 23:51:23 +05:00
This is a ToDo list which isn't sorted by any parameter at all. Just a list of tasks you can help with.
* User CP.
* Files uploading.
* Passwords for files.
* Pastes forking and revisioning (like git or github gists).
2020-02-29 23:51:23 +05:00
* Possibility to copy-paste-edit WYSIWYG content.
* CLI client for pastes and files uploading.