mirror of
https://github.com/alangrainger/immich-public-proxy.git
synced 2024-12-28 03:41:58 +00:00
Update docs
This commit is contained in:
parent
83847ba59b
commit
1324bd2b2f
2 changed files with 13 additions and 4 deletions
7
.github/workflows/ci.yaml
vendored
7
.github/workflows/ci.yaml
vendored
|
@ -3,7 +3,7 @@ name: Create and publish a Docker image
|
|||
on:
|
||||
push:
|
||||
tags:
|
||||
- 'v*' # Only on version tags like v1.0, v2.0, etc.
|
||||
- 'v*' # Only on version tags like v1.0, v2.0, etc.
|
||||
|
||||
env:
|
||||
REGISTRY: ghcr.io
|
||||
|
@ -39,9 +39,8 @@ jobs:
|
|||
uses: docker/metadata-action@v5
|
||||
with:
|
||||
images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
|
||||
tags:
|
||||
# set latest tag for default branch
|
||||
type=raw,value=latest,enable={{is_default_branch}}
|
||||
# set 'latest' tag for default branch (main)
|
||||
tags: type=raw,value=latest,enable={{is_default_branch}}
|
||||
|
||||
- name: Build and push Docker image
|
||||
uses: docker/build-push-action@v5
|
||||
|
|
10
README.md
10
README.md
|
@ -6,6 +6,16 @@ Share your Immich photos and albums in a safe way without exposing your Immich i
|
|||
<img src="public/images/immich.png" width="180" height="180">
|
||||
</p>
|
||||
|
||||
**Table of Contents**
|
||||
|
||||
- [About this project](#description)
|
||||
- [Install with Docker](#how-to-install-with-docker)
|
||||
- [How it works](#how-it-works)
|
||||
- [Additional configuration](#configuration)
|
||||
- [Feature requests](#feature-requests)
|
||||
|
||||
## About this project
|
||||
|
||||
Immich is a wonderful bit of software, but since it holds all your private photos it's best to keep it fully locked down.
|
||||
This presents a problem when you want to share a photo or a gallery with someone.
|
||||
|
||||
|
|
Loading…
Reference in a new issue