# ![Immich Public Proxy](<https://daemonless.io/images/logos/immich-public-proxy.svg>) Immich Public Proxy

[![Build Status](<https://img.shields.io/github/actions/workflow/status/daemonless/immich-public-proxy/build.yaml?style=flat-square&amp;label=Build&amp;color=green>)](<https://github.com/daemonless/immich-public-proxy/actions>) [![Last Commit](<https://img.shields.io/github/last-commit/daemonless/immich-public-proxy?style=flat-square&amp;label=Last+Commit&amp;color=blue>)](<https://github.com/daemonless/immich-public-proxy/commits>) [![OCI Pulls](<https://img.shields.io/docker/pulls/daemonless/immich-public-proxy?style=flat-square&amp;label=OCI+Pulls&amp;color=blue>)](<https://hub.docker.com/r/daemonless/immich-public-proxy>)

Share Immich photos and albums publicly without exposing the Immich instance itself.

[[![Immich Public Proxy screenshot 1](<https://daemonless.io/images/screenshots/immich-public-proxy/screenshot.webp>)](</images/screenshots/immich-public-proxy/screenshot.webp>)](</images/screenshots/immich-public-proxy/screenshot.webp>)

|  |  |
| --- | --- |
| **Port** | `3000` |
| **Registry** | [`ghcr.io/daemonless/immich-public-proxy`](<https://github.com/daemonless/immich-public-proxy/pkgs/container/immich-public-proxy>) |
| **Daemonless** | [daemonless/immich-public-proxy](<https://github.com/daemonless/immich-public-proxy>) |
| **Source** | [alangrainger/immich-public-proxy](<https://github.com/alangrainger/immich-public-proxy>) |
| **Website** | [github.com/alangrainger/immich-public-proxy](<https://github.com/alangrainger/immich-public-proxy>) |

This image is part of the [Immich Stack](<https://daemonless.io/images/immich>).

## Prerequisites

Before deploying, ensure your host environment is ready. See the [Quick Start Guide](<https://daemonless.io/guides/quick-start/index.md>) for host setup instructions, including the security model for host vs. container privileges.

## Deployment

**Customize Paths, UID &amp; Ports**

Install and manage **Immich Public Proxy** on FreeBSD with [fjord](<https://fjord.daemonless.io>):

```
fjord install immich-public-proxy
```

Or open the **App Store** in the fjord web UI and install **Immich Public Proxy** from the wizard. New to fjord? See the [Install Guide](<https://fjord.daemonless.io/install/>).

```
services:
  immich-public-proxy:
    image: "ghcr.io/daemonless/immich-public-proxy:latest"
    container_name: immich-public-proxy
    environment:
      - IMMICH_URL=  # URL of your (private) Immich instance, e.g. http://immich-server:2283
      - PUBLIC_BASE_URL=  # Public base URL this proxy is served from, no trailing slash (optional - derived from the request hostname if unset)
      - TZ=UTC  # Timezone for the container
      # - IPP_PORT=  # Internal webserver port (default 3000)
    ports:
      - "3000:3000"
    # always (not unless-stopped) so FreeBSD's podman rc.d auto-starts it at boot
    restart: always
```

Save as `compose.yaml`, then run `podman-compose up -d`.

> [!WARNING]
>
> Exposing ports in AppJail means that your service can be reached from remote hosts. If that is not your intention, do not expose the ports and communicate with the service using the jail's IPv4 address or hostname assigned by the virtual network.

```
# .env

DIRECTOR_PROJECT=immich-public-proxy
IMMICH_URL=
PUBLIC_BASE_URL=
TZ=UTC
```

```
# appjail-director.yml

options:
  - virtualnet: ':<random> default'
  - nat:
services:
  immich-public-proxy:
    name: immich_public_proxy
    options:
      - container: 'args:--pull'
      - expose: '3000:3000 proto:tcp'
    oci:
      user: root
      environment:
        - IMMICH_URL: !ENV '${IMMICH_URL}'
        - PUBLIC_BASE_URL: !ENV '${PUBLIC_BASE_URL}'
        - TZ: !ENV '${TZ}'
```

```
# Makejail

ARG tag=latest

OPTION container=boot
OPTION overwrite=force
OPTION from=ghcr.io/daemonless/immich-public-proxy:${tag}
```

Save the files above, then run `appjail-director up`.

> [!WARNING]
>
> **Experimental**
>
> Bastille's OCI support is experimental. It requires `buildah` and shares the host network stack (`inherit`). Mount volumes with `--volume HOST JAIL`; without it, image-declared volumes are stored under `${bastille_volumesdir}/${jail}`.

```
services:
  immich-public-proxy:
    name: immich-public-proxy
    image: "ghcr.io/daemonless/immich-public-proxy:latest"
    network:
      - mode: host
    environment:
      - IMMICH_URL=
      - PUBLIC_BASE_URL=
      - TZ=UTC
```

Save as `bastille-compose.yml`, then run `bastille up`.

Open `http://<server>:3000` from another machine (the server's own browser can't use a published port).

## Parameters

### Environment Variables

| Variable | Default | Description |
| --- | --- | --- |
| `IMMICH_URL` | \`\` | URL of your (private) Immich instance, e.g. [http://immich-server:2283](<http://immich-server:2283>) |
| `PUBLIC_BASE_URL` | \`\` | Public base URL this proxy is served from, no trailing slash (optional - derived from the request hostname if unset) |
| `TZ` | `UTC` | Timezone for the container |
| `IPP_PORT` | \`\` | Internal webserver port (default 3000) |

### Ports

| Port | Protocol | Description |
| --- | --- | --- |
| `3000` | TCP | Web UI |

## Version Tags

| Tag | Description | Best For |
| :--- | :--- | :--- |
| `latest` | **Upstream Binary**. Built from official release. | Most users — recommended. |

> [!NOTE]
>
> **Implementation Details**
>
> - **Architectures:** amd64
> - **User:** `bsd` (UID/GID set via [PUID/PGID](<https://daemonless.io/guides/permissions/index.md>)). Defaults to `1000:1000`.
> - **Base:** Built on `ghcr.io/daemonless/base` (FreeBSD 15).

---

Need help? Join our [Discord](<https://discord.gg/Kb9tkhecZT>) community.
