CSCWiki - User contributions [en]

Immich

2025-10-01T22:50:24Z

A89shaik: Add updating instructions

<span id="administration"></span>
== Administration ==
* Admin credentials are stored in [TODO].
* Take care not to touch the external libraries unless you know what you're doing; those are used to link users' Nextcloud data to their Immich accounts.

<span id="container-setup"></span>
== Container setup ==
Immich runs in <code>docker compose</code>. All relevant files can be found in <code>/root/immich</code> on guayusa.

<span id="access"></span>
== Access ==
In <code>/root/immich</code> on guayusa:
* <code>docker compose exec -it database psql -U postgres immich</code> will get you a psql shell in the Immich Postgres database.
* <code>curl https://photos.csclub.uwaterloo.ca/api/*</code> or <code>curl https://localhost:2283/api/*</code> lets you access the [https://api.immich.app/introduction Immich API]. You'll need to create an API key through the web UI -> Administration, then pass it in as the `x-api-key` header.

<span id="updating-immich"></span>
== Updating Immich ==

As root:
* <code>cd /root/immich</code>
* <code>docker compose pull</code>
* <code>docker compose up -d</code>

<span id="nginx"></span>
== Nginx ==

The Immich setup piggybacks off the nginx instance [https://wiki.csclub.uwaterloo.ca/Nextcloud#Setup_Nginx running in the Nextcloud container]. Once you've gained access to the container via <code>sudo machinectl shell nextcloud</code>, the nginx config can be found at <code>/etc/nginx/sites-available/immich</code>.

<span id="linking-nextcloud"></span>
== Linking Nextcloud ==

Every user who has logged into both Immich and Nextcloud will have an external library created in Immich, following the naming convention <code>[watiam]'s Library</code>. This allows Immich to access the user's images stored in Nextcloud, located at <code>/var/lib/machines/nextcloud/data/nextcloud-data/[watiam]/files</code>.

The libraries are created by the script <code>/root/immich/sync-libraries.sh</code>. It's in the root user's crontab, set to run every hour.

<span id="oidc-setup"></span>
== OIDC setup ==

OAuth can be configured in the web UI -> Administration from the admin account. [https://immich.app/docs/administration/oauth Documentation].

Main Page

2025-10-01T22:47:56Z

A89shaik: Add Immich to services

This is the Wiki of the [[Computer Science Club]]. Feel free to start adding pages and information.

[[Special:AllPages]]

== Member/Club Rep Documentation ==
To access our Linux machines, see [[How to SSH]] and select one of the general-use machines from [[Machine List#General-Use Servers]].

To host a website, see [[Web Hosting]]. If you are trying to host websites for clubs, see [[Club Hosting]].

To use our VPS services (similar to Linode and Amazon EC2), see [https://docs.cloud.csclub.uwaterloo.ca/ CSC Cloud Documentation]. Note that you'll need to activate your account on one of CSC's machines before using the management panel.

To view instruction on playing music at the office, see [[Music]].

To use our Nextcloud instance (similar to Google Drive and Dropbox), go to [https://files.csclub.uwaterloo.ca CSC Files].

=== Guides ===
<div style="-webkit-column-count:3; -moz-column-count:3; column-count:3;">
* [[New Member Guide]]
* [[Club Hosting]]
* [[Web Hosting]]
* [[Git Hosting]]
* [[How to IRC]]
* [[How to SSH]]
* [[MySQL]]
* [[PostgreSQL]]
* [https://docs.cloud.csclub.uwaterloo.ca/ CSC Cloud Documentation]
</div>

=== News and Events ===
<div style="-webkit-column-count:3; -moz-column-count:3; column-count:3;">
* [[Meetings]]
* [[Talks]]
* [[Projects]]
</div>

== Committees Documentation ==
=== Club Operation ===
<div style="-webkit-column-count:3; -moz-column-count:3; column-count:3;">
* [[Budget Guide]]
* [[ceo]]
* [[Exec Manual]]
* [[MEF Guide]]
* [[Office Policies]]
* [[Office Staff]]
* [[Sysadmin Guide]]
* [[How to (Extra) Ban Someone]]
* [[SCS Guide]]
* [[Kerberos |Password Reset]]
* [[Keys and Fobs]]

* [[Talks Guide]]
</div>

=== Hardware Infrastructure (the bare metals) ===
<div style="-webkit-column-count:3; -moz-column-count:3; column-count:3;">
* [[Disk Drive RMA Process]]
* [[Machine List]]
* [[IPMI101]]
* [[New NetApp]]
* [[Switches]]
</div>

=== Software Infrastructure ===
To see a complete list of services, where to find them and when they are updated, see [[Service List]].

<div style="-webkit-column-count:3; -moz-column-count:3; column-count:3;">
* [[ADFS]]
* [[Backups]]
* [[DNS]]
* [[Debian Repository]]
* [[Firewall]]
* [[Kerberos]]
* [[Matrix]]
* [[MatterMost]]
* [[Load-balancer]]
* [[Proxmox]]
* [[Plane]]
* [[RT]]
* [[Keycloak]]
* [[KVM]]
* [[LDAP]]
* [[Network]]
* [[New CSC Machine]]
* [[Observability]]
* [[OID Assignment]]
* [[Podman]]
* [[Scratch]]
* [[SNMP]]
* [[SSL]]
* [[Syscom Todo]]
* [[Systemd]]
* [[Systemd-nspawn]]
* [[Two-Factor Authentication]]
* [[UID/GID Assignment]]
</div>

=== Services ===
<div style="-webkit-column-count:3; -moz-column-count:3; column-count:3;">
* [[Application List]]
* [[BigBlueButton]]
* [[CodeyBot]]
* [[Mail]]
* [[Mailing Lists]]
* [[Mirror]]
* [[Music]]
* [[Nextcloud]]
* [[Immich]]
* [[Printing]]
* [[Pulseaudio]]
* [[Webmail]]
</div>

=== CSC Cloud ===
<div style="-webkit-column-count:3; -moz-column-count:3; column-count:3;">
* [[Ceph]]
* [[Cloud Networking]]
* [[CloudStack]]
* [[CloudStack Templates]]
* [[Kubernetes]]
</div>

== Miscellaneous ==
<div style="-webkit-column-count:3; -moz-column-count:3; column-count:3;">
* [[Acronyms]]
* [[Budget]]
* [[Executive]]
* [[Past Executive]]
* [[History]]
</div>

== Historical ==
<div style="-webkit-column-count:3; -moz-column-count:3; column-count:3;">
* [[Robot Arm]]
* [[Webcams]]
* [[Website]]
* [[Digital Cutter]]
* [[Electronics]]
* [[NetApp]]
* [[Frosh]]
* [[Virtualization (LXC Containers)]]
* [[Serial Connections]]
* [[Library]]
* [[MEF Proposals]]
* [[Proposed Constitution Changes]]
* [[NFS/Kerberos]]
* [[Hardware]]
* [[Imapd Guide]]
__NOTOC__

Immich

2025-09-30T14:25:57Z

A89shaik: Make headers consistent

== Administration ==
* Admin credentials are stored in [TODO].
* Take care not to touch the external libraries unless you know what you're doing; those are used to link users' Nextcloud data to their Immich accounts.

== Container setup ==
Immich runs in <code>docker compose</code>. All relevant files can be found in <code>/root/immich</code> on guayusa.

== Access ==
In <code>/root/immich</code> on guayusa:
* <code>docker compose exec -it database psql -U postgres immich</code> will get you a psql shell in the Immich Postgres database.
* <code>curl https://photos.csclub.uwaterloo.ca/api/*</code> or <code>curl https://localhost:2283/api/*</code> lets you access the [https://api.immich.app/introduction Immich API]. You'll need to create an API key through the web UI -> Administration, then pass it in as the `x-api-key` header.

<span id="nginx"></span>
== Nginx ==

The Immich setup piggybacks off the nginx instance [https://wiki.csclub.uwaterloo.ca/Nextcloud#Setup_Nginx running in the Nextcloud container]. Once you've gained access to the container via <code>sudo machinectl shell nextcloud</code>, the nginx config can be found at <code>/etc/nginx/sites-available/immich</code>.

<span id="linking-nextcloud"></span>
== Linking Nextcloud ==

Every user who has logged into both Immich and Nextcloud will have an external library created in Immich, following the naming convention <code>[watiam]'s Library</code>. This allows Immich to access the user's images stored in Nextcloud, located at <code>/var/lib/machines/nextcloud/data/nextcloud-data/[watiam]/files</code>.

The libraries are created by the script <code>/root/immich/sync-libraries.sh</code>. It's in the root user's crontab, set to run every hour.

<span id="oidc-setup"></span>
== OIDC setup ==

OAuth can be configured in the web UI -> Administration from the admin account. [https://immich.app/docs/administration/oauth Documentation].

Immich

2025-09-30T14:25:25Z

A89shaik: Create Immich page

<span id="administration"></span>
= Administration =

* Admin credentials are stored in [TODO].
* Take care not to touch the external libraries unless you know what you're doing; those are used to link users' Nextcloud data to their Immich accounts.

<span id="container-setup"></span>
= Container setup =

Immich runs in <code>docker compose</code>. All relevant files can be found in <code>/root/immich</code> on guayusa.

<span id="access"></span>
= Access =

In <code>/root/immich</code> on guayusa:
* <code>docker compose exec -it database psql -U postgres immich</code> will get you a psql shell in the Immich Postgres database.
* <code>curl https://photos.csclub.uwaterloo.ca/api/*</code> or <code>curl https://localhost:2283/api/*</code> lets you access the [https://api.immich.app/introduction Immich API]. You'll need to create an API key through the web UI -> Administration, then pass it in as the `x-api-key` header.

<span id="nginx"></span>
== Nginx ==

The Immich setup piggybacks off the nginx instance [https://wiki.csclub.uwaterloo.ca/Nextcloud#Setup_Nginx running in the Nextcloud container]. Once you've gained access to the container via <code>sudo machinectl shell nextcloud</code>, the nginx config can be found at <code>/etc/nginx/sites-available/immich</code>.

<span id="linking-nextcloud"></span>
== Linking Nextcloud ==

Every user who has logged into both Immich and Nextcloud will have an external library created in Immich, following the naming convention <code>[watiam]'s Library</code>. This allows Immich to access the user's images stored in Nextcloud, located at <code>/var/lib/machines/nextcloud/data/nextcloud-data/[watiam]/files</code>.

The libraries are created by the script <code>/root/immich/sync-libraries.sh</code>. It's in the root user's crontab, set to run every hour.

<span id="oidc-setup"></span>
== OIDC setup ==

OAuth can be configured in the web UI -> Administration from the admin account. [https://immich.app/docs/administration/oauth Documentation].