Julien Riou
9d9a0b842e
All checks were successful
/ pre-commit (push) Successful in 2m27s
The listen address is now 0.0.0.0 by default, we can remove `--network host` from the Docker command in the example. Signed-off-by: Julien Riou <julien@riou.xyz>
56 lines
1.2 KiB
Markdown
56 lines
1.2 KiB
Markdown
# Coller
|
|
|
|
Simple self-contained pastebin solution written in Go.
|
|
|
|
# Description
|
|
|
|
Coller is a set of binaries:
|
|
- **collerd**: HTTP server to handle note management
|
|
- **coller**: CLI to create notes
|
|
- **copier**: CLI to download and decrypt notes (client-side decryption)
|
|
|
|
# Installation
|
|
|
|
## From source code
|
|
|
|
Requires [Go](https://go.dev/dl/).
|
|
|
|
```
|
|
git clone https://git.riou.xyz/jriou/coller.git
|
|
cd coller
|
|
make
|
|
sudo cp -p bin/* /usr/local/bin/
|
|
```
|
|
|
|
## Docker
|
|
|
|
```
|
|
git clone https://git.riou.xyz/jriou/coller.git
|
|
cd coller
|
|
docker build -t coller:latest .
|
|
docker run --rm --name collerd -p 8080:8080 coller:latest
|
|
```
|
|
|
|
Then go to http://localhost:8080 (website).
|
|
|
|
## Ansible
|
|
|
|
See [ansible-role-coller](https://git.riou.xyz/jriou/ansible-role-coller).
|
|
|
|
|
|
# Usage and configuration
|
|
|
|
* [collerd](src/cmd/collerd/README.md)
|
|
* [coller](src/cmd/coller/README.md)
|
|
* [copier](src/cmd/copier/README.md)
|
|
|
|
# Contributions
|
|
|
|
Contributions are welcomed! Feel free to provide unit tests when possible. Lint
|
|
your code with `go fmt`. If you don't feel confident enough to contribute, feel
|
|
free to open an issue to describe the feature you would like to see implemented
|
|
or the problem you are facing.
|
|
|
|
# License
|
|
|
|
See [LICENSE](LICENSE).
|