3rob3 / ImmichFrame

ImmichFrame

An awesome way to display your photos as an digital photo frame
Explore immich »

Report Bug · Request Feature

⚠️ Disclaimer

This project is not affiliated with immich!

About The Project

This project is a digital photo frame application that interfaces with your immich server. It is a cross-platform C# .NET 7 project that currently supports Linux, macOS, and Windows.

Built With

• 

✨ Demo

Getting Started

ImmichFrame is easy to run on your desired plattform.

Prerequisites

• A set up and functioning immich server

Installation

Important

Make sure to copy the Settings.example.xml and name it Settings.xml

1. Get the latest release from the release page and unzip
2. Rename the Settings.example.xml file to Settings.xml
3. Change <ImmichServerUrl> to your domain or local ip

    <ImmichServerUrl>http://yourdomain.com</ImmichServerUrl>

4. Change <ApiKey>. Read more about immich ApiKey here: https://immich.app/docs/features/command-line-interface#obtain-the-api-key

    <ApiKey>YourApiKey</ApiKey>

5. Optional: Choose albums you would like to display

    <Albums>
        <Album>First Album UID</Album>
        <Album>Second Album UID</Album>
    </Albums>

6. Adjust other settings to your needs

Usage

Linux

• GUI - Double-click Immich_Frame.
• CLI - CD into folder, and launch with "./Immich_Frame".
• SSH - CD into folder, and launch with "DISPLAY=:0.0 ./Immich_Frame".

Windows

• Double-click Immich_Frame.
• Screensaver - Rename Immich_Frame.exe to Immich_Frame.scr. Right-click-Install. Configure screensaver settings and apply. Note: you will still have to click middle/bottom in the app to exit screensaver.

MacOS

• Double-click Immich_Frame. Note: If nothing happens, right-click-open with-Utilities-Terminal. Check Always Open With.

Roadmap

• Display random assets
• Display Albums
• Display Memories
• Add Additional Templates w/ Examples
• Add License

See the open issues for a full list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

TODO

Contact

TODO

Acknowledgments

BIG thanks to the immich-team for creating an awesome tool

• immich
• Img Shields
• GitHub Pages