A low-tech content management system for the web
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

168 lines
5.2 KiB

3 years ago
# distribusi-go
> This is still very experimental, please take a backup of your archives if you
> are running it on files you care about. It hasn't been tested on large
> archives. There are probably some pretty bad bugs lurking in there. It may
> still thrash files. Please [report issues] as you find them :100: Thanks for
> testing!
3 years ago
A [Go] implementation of [distribusi].
If you're migrating from the Python version or have experience using it, here are the differences in `distribusi-go`:
3 years ago
- It's simpler to install on your computer, just download the binary, `chmod
+x` and run it :100:
3 years ago
- There is no need to install [Pillow] for handling images, that is now
built-in. The only external dependency is [exiftool] for image captions from
embedded metadata. If you don't have `exiftool` installed, then it gracefully
skips that feature. So, you don't need to install anything else to run
`distribusi` now :pray:
- The command-line interface is quite different. There are less optional flags
and more defaults. I shuffled a number of things around according to my
preferences (open to changes, please [open a ticket]). For example, I always
like my images to be thumbnail'd. There's a handy web server built-in now,
just run with `-s` :metal:
3 years ago
## Install
:champagne: `distribusi-go` has enterprise cross-platform support! :champagne:
If your platform isn't listed below, please see [the entire listing]. If you
can't find it there, we can probably add support for it (see `$GOOS`/`$GOARCH`
[on go.dev]), please [open a ticket]. Package manager installation methods are
planned for Some Time Soon :tm: (e.g. `apt install distribusi`, see [this ticket] to track)
### GNU/Linux
<details><summary>GNU/Linux (amd64)</summary>
<pre>
curl https://vvvvvvaria.org/~decentral1se/distribusi-go/0.1.0-alpha/distribusi_linux_amd64/distribusi -o distribusi
3 years ago
chmod +x distribusi
./distribusi -h # check things work
</pre>
</details>
<details><summary>GNU/Linux (386)</summary>
<pre>
curl https://vvvvvvaria.org/~decentral1se/distribusi-go/0.1.0-alpha/distribusi_linux_386/distribusi -o distribusi
chmod +x distribusi
./distribusi -h # check things work
</pre>
</details>
<details><summary>GNU/Linux (arm64)</summary>
<pre>
curl https://vvvvvvaria.org/~decentral1se/distribusi-go/0.1.0-alpha/distribusi_linux_arm64/distribusi -o distribusi
chmod +x distribusi
./distribusi -h # check things work
</pre>
</details>
### Mac OS X
<details><summary>Mac OS X (amd64)</summary>
<pre>
curl https://vvvvvvaria.org/~decentral1se/distribusi-go/0.1.0-alpha/distribusi_darwin_amd64/distribusi -o distribusi
chmod +x distribusi
./distribusi -h # check things work
</pre>
</details>
<details><summary>Mac OS X (arm64)</summary>
<pre>
curl https://vvvvvvaria.org/~decentral1se/distribusi-go/0.1.0-alpha/distribusi_darwin_arm64/distribusi -o distribusi
chmod +x distribusi
./distribusi -h # check things work
</pre>
</details>
### Windows
<details><summary>Windows (amd64)</summary>
I've no idea how you even install this on Windoze! Maybe you can help by
sending a documentation patch? :pray:
> https://vvvvvvaria.org/~decentral1se/distribusi-go/0.1.0-alpha/distribusi_windows_amd64/distribusi.exe
</details>
<details><summary>Windows (386)</summary>
I've no idea how you even install this on Windoze! Maybe you can help by
sending a documentation patch? :pray:
> https://vvvvvvaria.org/~decentral1se/distribusi-go/0.1.0-alpha/distribusi_windows_386/distribusi.exe
</details>
3 years ago
## Quick start
Run `distribusi-go` on `<path>` and serve it locally for viewing:
```bash
./distribusi -p <path> -s
```
If you want to ignore certain paths, you can use `-i/--ignore`:
```bash
./distribusi -p <path> -s -i '*.gif, *.md, mydir'
```
It supports a list of patterns in a comma separated list, wildcards work, more [on pkg.go.dev].
If you run into issues, run with `-d/--debug`. All debug logs are stored in a time stamped log file under `/tmp/`.
```bash
➜ ls /tmp/ | grep -i distribusi
distribusi-go-20-25-492637114356
```
:v:
3 years ago
## Hacking
You'll need [Go] >= 1.11 installed. Run `make` to build a new `./distribusi` executable.
3 years ago
If you wanna learn Go, I've got [this book], feel free to take a loan of it :grinning:
## Release
Currently, you have to be `@decentral1se` to do this:
```bash
git tag <version>
VERSION=<version> make release
```
You can build a local-only release by running this:
```bash
goreleaser release --snapshot --rm-dist
```
Binaries are in `dist/`.
## Acknowledgements
[`AUTHORS.md`](./AUTHORS.md)
## License
![](https://www.gnu.org/graphics/gplv3-or-later.png)
[`LICENSE`](./LICENSE)
[Go]: https://go.dev
[Pillow]: https://pillow.readthedocs.io/en/stable/installation.html#external-libraries
[distribusi]: https://git.vvvvvvaria.org/varia/distribusi
[exiftool]: https://exiftool.org/
[on go.dev]: https://go.dev/doc/install/source#environment
[on pkg.go.dev]: https://pkg.go.dev/path/filepath#Match
[open a ticket]: https://git.vvvvvvaria.org/decentral1se/distribusi-go/issues/new/choose
[report issues]: https://git.vvvvvvaria.org/decentral1se/distribusi-go/issues/new/choose
[the entire listing]: https://vvvvvvaria.org/~decentral1se/distribusi-go/
[this book]: https://www.gopl.io/
[this ticket]: https://git.vvvvvvaria.org/decentral1se/distribusi-go/issues/1