diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index ce8fcd8..20859f7 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -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 diff --git a/README.md b/README.md index 29118ac..f85b91f 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,16 @@ Share your Immich photos and albums in a safe way without exposing your Immich i

+**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.