Skip to content

Commit

Permalink
Readme updates
Browse files Browse the repository at this point in the history
  • Loading branch information
nikolaydimitrov committed Nov 26, 2024
1 parent 107ae0c commit 106e454
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,12 @@ ___
- Supports either locally mounted disks or
- S3-compatible Services - this allows different users to use their own S3 bucket on the same server
- Push notifications for new Album photos, etc
- Face detection and tagging
- Albums
- Adding local server contributors and viewers
- Sharing albums with anyone with a "secret" link
- Chat with push notifications
- Filtering photos by year, month, location, etc
- Filtering photos by tagged person, year, month, location, etc
- Moments - automatically grouping photos by time and location
- Reverse geocoding for all assets
- Automatic video conversion to web-compatible H.264 format
Expand All @@ -61,6 +62,9 @@ Current configuration environment variables:
- `DEBUG_MODE` - currently defaults to `yes`
- `DEFAULT_BUCKET_DIR` - a directory that will be used as default bucket if no other buckets exist (i.e. the first time you run the server)
- `DEFAULT_ASSET_PATH_PATTERN` - the default path pattern to create subdirectories and file names based on asset info. Defaults to `<year>/<month>/<id>`
- `PUSH_SERVER` - the push server URL. Defaults to `https://push.circled.me`
- `FACE_DETECT_CNN` - use Convolutional Neural Network for face detection (as opposed to HOG). Much slower, but more accurate at different angles. Defaults to `no`
- `FACE_MAX_DISTANCE_SQ` - squared distance between faces to consider them similar. Defaults to `0.11`

## docker-compose example
```yaml
Expand Down
8 changes: 2 additions & 6 deletions config/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,6 @@ import (
"strings"
)

const (
FaceThresholdSquared = 0.36 // 0.6^2
)

var (
TLS_DOMAINS = "" // e.g. "example.com,example2.com"
DEFAULT_ASSET_PATH_PATTERN = "<year>/<month>/<id>" // also available: <name>, <Month>
Expand All @@ -20,8 +16,8 @@ var (
TMP_DIR = "/tmp" // Used for temporary video conversion, etc (in case of S3 bucket)
DEFAULT_BUCKET_DIR = "" // Used for creating initial bucket
DEBUG_MODE = true
FACE_DETECT_CNN = true // Use Convolutional Neural Network for face detection (as opposed to HOG). Much slower, supposedly more accurate at different angles
FACE_MAX_DISTANCE_SQ = 0.11 // Squared distance between faces to consider them similar
FACE_DETECT_CNN = false // Use Convolutional Neural Network for face detection (as opposed to HOG). Much slower, supposedly more accurate at different angles
FACE_MAX_DISTANCE_SQ = 0.11 // Squared distance between faces to consider them similar
)

func init() {
Expand Down

0 comments on commit 106e454

Please sign in to comment.