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.

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

Immich custom service #673

Merged
merged 2 commits into from
Aug 6, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
12 changes: 12 additions & 0 deletions docs/customservices.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ within Homer:
- [SABnzbd](#sabnzbd)
- [OctoPrint](#octoprint)
- [Tdarr](#tdarr)
- [Immich](#immich)

If you experiencing any issue, please have a look to the [troubleshooting](troubleshooting.md) page.

Expand Down Expand Up @@ -411,3 +412,14 @@ for transcoding on your Tdarr instance as well as the number of errored items.
type: "Tdarr"
checkInterval: 5000 # (Optional) Interval (in ms) for updating the queue & error counts
```

## Immich

The Immich service displays stats from your Immich server.

```yaml
- name: "Immich"
type: "Immich"
apikey: "<--- Your api key --->" # administrator user
updateInterval: 5000 # (Optional) Interval (in ms) for updating the stats
```
1 change: 1 addition & 0 deletions dummy-data/immich/api/server-info/stats
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"photos":25754,"videos":1774,"usage":123142197784,"usageByUser":[{"userId":"28eff0e8-60b3-4b4c-9236-bd48559b1400","userFirstName":"John","userLastName":"Doe","photos":14153,"videos":501,"usage":54391364678},{"userId":"f3051051-9794-3470-b253-d1d7c1d46ef3","userFirstName":"John","userLastName":"Doe","photos":0,"videos":0,"usage":0},{"userId":"940bd5e2-bf3d-33e6-86b6-b9d60a1d1e06","userFirstName":"Jane","userLastName":"Doe","photos":11601,"videos":1273,"usage":68750833106}]}
126 changes: 126 additions & 0 deletions src/components/services/Immich.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,126 @@
<template>
<Generic :item="item">
<template #indicator>
<div class="notifs">
<strong v-if="users > 0" class="notif users" title="Users">
{{ users }}
</strong>
<strong v-if="photos > 0" class="notif photos" title="Photos">
{{ photos }}
</strong>
<strong v-if="videos > 0" class="notif videos" title="Videos">
{{ videos }}
</strong>
<strong v-if="usage > 0" class="notif usage" title="Usage">
{{ humanizeSize }}
</strong>
<strong
v-if="serverError"
class="notif errors"
title="Connection error to Immich API, check your url and apikey in config.yml"
>?</strong
>
</div>
</template>
</Generic>
</template>

<script>
import service from "@/mixins/service.js";
import Generic from "./Generic.vue";

export default {
name: "Immich",
mixins: [service],
props: {
item: Object,
},
components: {
Generic,
},
data: () => {
return {
users: null,
photos: null,
videos: null,
usage: null,
serverError: false,
};
},
created: function () {
const updateInterval = parseInt(this.item.updateInterval, 10) || 0;
if (updateInterval > 0) {
setInterval(() => this.fetchConfig(), updateInterval);
}
this.fetchConfig();
},
computed: {
humanizeSize: function () {
let bytes = this.usage;
if (Math.abs(bytes) < 1024)
return bytes + ' B';

const units = ['KiB', 'MiB', 'GiB', 'TiB'];
let u = -1;
do {
bytes /= 1024;
++u;
} while (Math.round(Math.abs(bytes) * 100) / 100 >= 1024 && u < units.length - 1);

return bytes.toFixed(2) + ' ' + units[u];
},
},
methods: {
fetchConfig: function () {
const headers = {
"x-api-key": this.item.apikey,
};

this.fetch(`/api/server-info/stats`, { headers })
.then((stats) => {
this.photos = stats.photos;
this.videos = stats.videos;
this.usage = stats.usage;
this.users = stats.usageByUser.length;
})
.catch((e) => {
console.error(e);
this.serverError = true;
});
},
},
};
</script>

<style scoped lang="scss">
.notifs {
position: absolute;
color: white;
font-family: sans-serif;
top: 0.3em;
right: 0.5em;
.notif {
display: inline-block;
padding: 0.2em 0.35em;
border-radius: 0.25em;
position: relative;
margin-left: 0.3em;
font-size: 0.8em;
&.photos {
background-color: #4fb5d6;
}

&.videos {
background-color: #d08d2e;
}

&.usage {
background-color: #e51111;
}

&.users {
background-color: #8dd475;
}
}
}
</style>
Loading