Stanislav N. aka pztrn
2b44a60ee7
Great linting fixes has been applied, thanks to golangci-lint for extensive reporting. Fixed Drone configuration to use array for when-branch statement in Docker plugin. Flatfile storage from now will write files with 0600 permission for greater security. |
||
---|---|---|
assets | ||
cmd/fastpastebin | ||
docker | ||
domains | ||
examples | ||
internal | ||
systemd | ||
.drone.yml | ||
.gitignore | ||
.gitlab-ci.yml | ||
.golangci.yml | ||
builder.sh | ||
CHANGELOG.md | ||
docker-compose.yml | ||
Dockerfile | ||
fileb0x.yml | ||
go.mod | ||
go.sum | ||
LICENSE | ||
README.md |
Fast Pastebin
Easy-to-use-and-install pastebin software written in Go. No bells or whistles, no websockets and even NO JAVASCRIPT!
Current functionality
- Create and view public and private pastes.
- Syntax highlighting.
- Pastes expiration.
- Passwords for pastes.
- Multiple storage backends. Currently:
flatfiles
,mysql
andpostgresql
.
Caveats
- No links at lines numbers. See this Chroma bug
Installation and updating
Just issue:
CGO_ENABLED=0 go get -u -v go.dev.pztrn.name/fastpastebin/cmd/fastpastebin
This command can be used to update Fast Paste Bin.
Configuration
Take a look at example configuration file 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 -config
CLI parameter or FASTPASTEBIN_CONFIG
environment variable to specify path.
Developing
Developers should install fileb0x which is used as replacement to go-bindata for embedding assets into binary. After changing assets they should be recompiled into Go code. At repository root execute this command and you'll be fine:
fileb0x fileb0x.yml
Also if you're changed list of assets (by creating or deleting them) be sure to fix files list in fileb0x.yml
file!
The rest is default - use linters, formatters, etc. VSCode with Go plugin is recommended for developing as it will perform most of linting-formatting actions automagically. Try to follow Go's code review comments with few exceptions:
- Imports should be organized in 3 groups: stdlib, local, other. See this file for example.
- We're not forcing any limits on line length for code, only for comments, they should be 72-76 chars long.
ToDo
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).
- Possibility to copy-paste-edit WYSIWYG content.
- CLI client for pastes and files uploading.