diff options
| -rw-r--r-- | Caddyfile.example | 12 | ||||
| -rw-r--r-- | README.md | 46 |
2 files changed, 46 insertions, 12 deletions
diff --git a/Caddyfile.example b/Caddyfile.example deleted file mode 100644 index fa7fd56..0000000 --- a/Caddyfile.example +++ /dev/null @@ -1,12 +0,0 @@ -{ - supervisor { - ./gallery serve --addr :8020 --data ./gallery-data { - dir /home/ubuntu - restart_policy always - } - } -} - -pics.kagamino.dev { - reverse_proxy localhost:8020 -} diff --git a/README.md b/README.md new file mode 100644 index 0000000..207a7cd --- /dev/null +++ b/README.md @@ -0,0 +1,46 @@ +# kagapics + +A lightweight, self-hosted photo gallery for collecting trip photos from friends. Single Go binary, no database, no runtime dependencies. + +## Build + +```sh +go build -o gallery . +``` + +## Usage + +### Create a gallery + +```sh +./gallery create <name> <password> [--data ./gallery-data] [--no-thumbs] +``` + +### Start the server + +```sh +./gallery serve [--addr :8080] [--data ./gallery-data] +``` + +### Caddy reverse proxy + +```caddy +{ + supervisor { + ./gallery serve --addr :8020 --data ./gallery-data { + dir /home/ubuntu + restart_policy always + } + } +} + +pics.example.com { + reverse_proxy localhost:8020 +} +``` + +## Test + +```sh +go test ./... +``` |