krz/skunky-art

 1┌──────────────────────────────────────────────────────────────┐
 2│  S K U N K Y A R T                         [ KRZ ]   krz.sh  │
 3└──────────────────────────────────────────────────────────────┘
 4
 5FORK
 6  fork of SkunkyArt (https://git.macaw.me/skunky/SkunkyArt). upstream
 7  hasn't updated in over a year, has open bugs, and its listed
 8  instances are dead links. this fork keeps it maintained.
 9
10WHAT
11  skunkyart. alternative frontend for deviantart. works with no
12  javascript.
13
14  instances: INSTANCES.txt
15
16BUILD
17  build with the embed tag to embed presets in the binary. skip the
18  tag if you'll modify templates. add -ldflags "-w -s" (gccgo:
19  gccgoflags) to shrink the output:
20
21      go build -tags embed -ldflags "-w -s"
22
23  that build reports its version as dev. stamp one in with
24  -X main.version=<version>, as the release workflow does from the
25  git tag.
26
27DOCKER
28  multi-arch images (linux/amd64, linux/arm64) publish to ghcr on
29  every release tag:
30
31      docker pull ghcr.io/krazywarez/skunky-art:latest
32
33  each release is tagged 1.3.3, 1.3, 1, and latest. pin an exact
34  version for reproducible upgrades. compose.example.yaml uses the
35  image; compose.vpn_example.yml adds an optional vpn egress sidecar.
36
37CONFIG
38  sample config in config.example.json. custom config with --config.
39  directive details in SETUP.txt.
40
41INSTANCES
42  add yours by pr to instances.json and INSTANCES.txt (or use
43  --add-instance to write both), or open an issue.
44
45┌──────────────────────────────────────────────────────────────┐
46│  krz.sh                                                      │
47└──────────────────────────────────────────────────────────────┘