ImmichFrame Remote - Control your immich frame web instance with HTTP Get requests

This repository contains a Dockerized HTTPOut server designed to interact with an ImmichFrame Web setup. Provided scripts will allow users to remotely change to the next/previous frame or play/pause the frame.

Prerequisites

Before proceeding, ensure your environment is set up correctly:

1. Ensure .Xauthority File is Available

Check that the .Xauthority file exists on your host system and contains valid X11 authentication credentials:

ls -l /path/to/.Xauthority
xauth list

2. Install Docker and Docker Compose

Make sure Docker and Docker Compose are installed on your system. For installation instructions, visit Docker’s official documentation.

Build and Run the Container

1. Clone the repository:

   git clone https://github.com/iCanHazSkillz/immichframe-remote.git
   cd immichframe-remote

2. Environment Variables Open the provided .env file with your favorite text editor and ensure the variables match your host system:

   DISPLAY=:0  # Adjust based on your system setup
   XAUTHORITY=/path/to/.Xauthority  # Full path to your .Xauthority file
   UID=1000  # User ID of your host user
   GID=1000  # Group ID of your host user

• Replace /path/to/.Xauthority with the actual path on your host machine, e.g., /home/user/.Xauthority.

3. Build and start the container:

   sudo docker compose up --build -d

4. Verify the container is running:

   sudo docker ps

5. Test the server:

   curl http://localhost:8000/next.py

File Structure

immichframe-remote/
├── Dockerfile            # Defines the container setup
├── docker-compose.yml    # Defines the service configuration
├── .env                  # Environment variables for flexibility
└── scripts/              # Application scripts
    ├── previous.py       # Script for previous frame
    ├── next.py           # Script for next frame
    └── play-pause.py     # Script for play/pause frame

Troubleshooting

1. Missing .Xauthority File in Container

If the container logs indicate a missing .Xauthority file:

• Verify the file exists on your host:

  ls -l /path/to/.Xauthority

• Confirm it’s mapped correctly in docker-compose.yml.
• Check the DISPLAY environment variable matches your host setup.

2. xauth Not Found in Container

Ensure xauth is installed in the container. The Dockerfile already includes:

RUN apt-get update && apt-get install -y xauth

Rebuild the container if necessary:

sudo docker compose build --no-cache

3. Cannot Connect to the HTTPOut Server

• Check the logs of the container:

  sudo docker logs immichframe-remote

• Verify the server is running on port 8000.

Contributing

Feel free to fork this repository and submit pull requests for improvements or additional features.

License

This project is licensed under the MIT License. See the LICENSE file for details.