Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: rearranging and adding information #239

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: rearranging and adding information #239

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions Install_Web.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,8 @@ services:
restart: on-failure
volumes:
- PATH/TO/CONFIG:/app/Config
# - PATH/TO/ImageCacheFolder:/app/ImageCache #(this is optional. See https://github.com/immichFrame/ImmichFrame#caching)

ports:
- "8080:8080"
environment:
Expand Down
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,15 @@ Weather is enabled by entering an API key. Get yours free from [OpenWeatherMap][
### Calendar
If you are using Google Calendar, more information can be found [here](https://support.google.com/calendar/answer/37648?hl=en#zippy=%2Cget-your-calendar-view-only).

### Caching

This will download new images into a ImageCache-Folder. Images will be refreshed after the number of days configured in the RenewImagesDuration-Setting. You can enable this features with the DownloadImages-Setting.

To make it work you will need to uncomment `# - PATH/TO/ImageCacheFolder:/app/ImageCache` in your installation file.

> [!NOTE]
> If you enable the DownloadImages option to True without setting volumes for ImageCacheFolder it will cause an error!
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just to clarify for me, this does not cause an error if you don't set it in your volumes, right? This only throws an error if you uncomment it and do not change the value to a valid folder?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When I tried to set the DownloadImages option to True it threw errors until I set a folder for DownloadImages ~ ImageCacheFolder.

This should not be the case. Do you have an error message? This is most likely a bug. The "ImageCache"-folder should be created in the application. I like the volume you made :)


### Metadata
Needs documentation

Expand Down
2 changes: 1 addition & 1 deletion docker/Settings.example.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@
"Interval": 10,
"TransitionDuration": 2,
"DownloadImages": false,
"RenewImagesDuration": 30,
"ShowMemories": false,
"ImagesFromDays": 365,
"ImagesFromDate": "",
"ImagesUntilDate": "",
"RenewImagesDuration": 30,
"Albums": [
""
],
Expand Down
3 changes: 2 additions & 1 deletion docker/docker-compose.dev.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,5 @@ services:
env_file:
- .env
# volumes:
# - PATH/TO/CONFIG:/app/Config
# - PATH/TO/CONFIG:/app/Config
# - PATH/TO/ImageCacheFolder:/app/ImageCache #(this is optional. See https://github.com/immichFrame/ImmichFrame#caching)
1 change: 1 addition & 0 deletions docker/docker-compose.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ services:
restart: on-failure
# volumes:
# - PATH/TO/CONFIG:/app/Config
# - PATH/TO/ImageCacheFolder:/app/ImageCache #(this is optional. See https://github.com/immichFrame/ImmichFrame#caching)
ports:
- "8080:8080"
env_file:
Expand Down
2 changes: 1 addition & 1 deletion docker/example.env
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ Margin=0,0,0,0
Interval=10
TransitionDuration=2
DownloadImages=false
RenewImagesDuration=30
ShowMemories=false
ImagesFromDays=
ImagesFromDate=
ImagesUntilDate=
RenewImagesDuration=30
Albums=ALBUM1,ALBUM2
ExcludedAlbums=ALBUM3,ALBUM4
People=PERSON1,PERSON2
Expand Down
Loading