aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: d69f540d0cb04853e13ef8e87f99735feaf42c89 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50

# 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 ./...
```

## TODO

- [ ] CLI command to cleanup a gallery: remove config and folder