feat: Upgrade devcontainer setup

[Zer0x00]

Upgrades the devcontainer implementation with the following changes:

• Prepares the dev environment fully with all the needed tools and SDKs
• Starts all the immich docker containers directly with the devcontainer
• installs & sets all VSCode extensions and settings from https://immich.app/docs/developer/setup/#vscode
• Included a workaround to run amd64 binaries for aarch64/arm64 machines like an Apple Silicon Mac

To start the immich docker containers there must be an .env file available but I didn't like failing the start of the devcontainer. Instead if the .env file isn't found under the .devcontainer folder it will copy the example.env from the docker folder and use that instead. Unfortunately the .env file must be existing in the .devcontainer folder - I couldn't find a way to use the .env file from the docker folder.

[bo0tzz]

This is awesome, I've been wanting a setup like it for a long time. Thank you very much!

Can you also add some instructions to the developer documentation on how to use this?

@mcarbonne since you added the original devcontainer bits, do you have any feedback on this PR?

[bo0tzz]

I think for compatibility with github codespaces this needs to be /workspaces/immich?

[Zer0x00]

Tested it, seems not to be a requirement.

[bo0tzz]

When running this in codespaces I get the following error

2024-12-01 11:09:52.087Z: can't set healthcheck.start_interval as feature require Docker Engine v25 or later
2024-12-01 11:09:52.090Z: Stop: Run: docker compose --project-name immich-dev -f /var/lib/docker/codespacemount/workspace/immich/.devcontainer/docker-compose.yml -f /var/lib/docker/codespacemount/workspace/immich/docker/docker-compose.dev.yml -f /var/lib/docker/codespacemount/.persistedshare/docker-compose.codespaces.yml -f /var/lib/docker/codespacemount/.persistedshare/docker-compose/docker-compose.devcontainer.build-1733051096983.yml -f /var/lib/docker/codespacemount/.persistedshare/docker-compose/docker-compose.devcontainer.containerFeatures-1733051372652-aaef61db-ffe0-42ff-a242-e6d49cb8333f.yml up -d
2024-12-01 11:09:52.091Z: {"outcome":"error","message":"Command failed: docker compose --project-name immich-dev -f /var/lib/docker/codespacemount/workspace/immich/.devcontainer/docker-compose.yml -f /var/lib/docker/codespacemount/workspace/immich/docker/docker-compose.dev.yml -f /var/lib/docker/codespacemount/.persistedshare/docker-compose.codespaces.yml -f /var/lib/docker/codespacemount/.persistedshare/docker-compose/docker-compose.devcontainer.build-1733051096983.yml -f /var/lib/docker/codespacemount/.persistedshare/docker-compose/docker-compose.devcontainer.containerFeatures-1733051372652-aaef61db-ffe0-42ff-a242-e6d49cb8333f.yml up -d","description":"An error occurred starting Docker Compose up."}
2024-12-01 11:09:52.091Z: Error: Command failed: docker compose --project-name immich-dev -f /var/lib/docker/codespacemount/workspace/immich/.devcontainer/docker-compose.yml -f /var/lib/docker/codespacemount/workspace/immich/docker/docker-compose.dev.yml -f /var/lib/docker/codespacemount/.persistedshare/docker-compose.codespaces.yml -f /var/lib/docker/codespacemount/.persistedshare/docker-compose/docker-compose.devcontainer.build-1733051096983.yml -f /var/lib/docker/codespacemount/.persistedshare/docker-compose/docker-compose.devcontainer.containerFeatures-1733051372652-aaef61db-ffe0-42ff-a242-e6d49cb8333f.yml up -d
2024-12-01 11:09:52.092Z:     at ltA (/.codespaces/agent/bin/node_modules/@devcontainers/cli/dist/spec-node/devContainersSpecCLI.js:430:3355)
2024-12-01 11:09:52.092Z:     at process.processTicksAndRejections (node:internal/process/task_queues:95:5)
2024-12-01 11:09:52.092Z:     at async ctA (/.codespaces/agent/bin/node_modules/@devcontainers/cli/dist/spec-node/devContainersSpecCLI.js:410:3506)
2024-12-01 11:09:52.093Z:     at async YtA (/.codespaces/agent/bin/node_modules/@devcontainers/cli/dist/spec-node/devContainersSpecCLI.js:482:3944)
2024-12-01 11:09:52.093Z:     at async eB (/.codespaces/agent/bin/node_modules/@devcontainers/cli/dist/spec-node/devContainersSpecCLI.js:482:4886)
2024-12-01 11:09:52.093Z:     at async prA (/.codespaces/agent/bin/node_modules/@devcontainers/cli/dist/spec-node/devContainersSpecCLI.js:663:200)
2024-12-01 11:09:52.094Z:     at async drA (/.codespaces/agent/bin/node_modules/@devcontainers/cli/dist/spec-node/devContainersSpecCLI.js:662:14706)
2024-12-01 11:09:52.099Z: devcontainer process exited with exit code 1

which suggests that codespaces is running an outdated docker version, but I can't figure out which version or why. Of course this can be 'fixed' by removing the healthcheck, but I'd rather it run an up to date docker engine. Do you have any insight into that?

[Zer0x00]

I focused the devcontainer on local development, didn't test with codespaces until now since I'm not using it at all.
Even though removing the offending line spawned the containers successfully the web container returned a 500 server error - I'm not sure why. Tried to use docker-outside-of-docker instead but there I had some other problems. Maybe someone else can work on letting this run on GitHub codespaces, I'm too unexperienced with it and unfortunately don't have time to look into it.

[bo0tzz]

The devcontainer setup looks good, thank you! Can you add some instructions on how to use it to the docs at https://immich.app/docs/developer/setup? After that this'll be ready to merge imo :)

[Zer0x00]

The instruction to set the settings is not necessary anymore I guess since those are now set in https://github.com/immich-app/immich/blob/main/.vscode/settings.json

Should the current instructions for installing extensions be left in there as a second option to set the environment up manually?