Docker-less Alpine installation #556

Chiogros · 2022-08-31T12:44:24Z

Hi,

The docker-based installation is not convenient for everyone.
For example, a docker-less installation would allow LXC/D containers usage, without using tricky tips for using Docker inside of them.

I already successfully installed a standalone Immich.
This branch would be used for scripting a command-line interactive installation.

Thanks for your feedback!

alextran1502 · 2022-08-31T13:15:31Z

FYI, you can run this image to run docker in LXC normally

This is how I run Immich on my Promox/LXC setup

Chiogros · 2022-08-31T13:41:19Z

There are some tips to run Docker in LXC containers (playing with nesting option if I remember), although IMO it is not the best way to do.

alextran1502 · 2022-08-31T14:13:08Z

There are some tips to run Docker in LXC containers (playing with nesting option if I remember), although IMO it is not the best way to do.

What are the reasons?

Chiogros · 2022-08-31T14:48:14Z

Allowing a container to go out of its initial scope, even if sometimes it can be convenient, is not the good way just for running applications.

In the same way as in Docker you could use --privilegied, running a LXC container with privilegied rights could lead to some security flaws.
(My) PVE is hosting toons of services, I can't imagine a single one being able to disturb the host system.

alextran1502 · 2022-08-31T14:55:20Z

Allowing a container to go out of its initial scope, even if sometimes it can be convenient, is not the good way just for running applications.

In the same way as in Docker you could use --privilegied, running a LXC container with privilegied rights could lead to some security flaws. (My) PVE is hosting toons of services, I can't imagine a single one being able to disturb the host system.

It's my point of view, I though it could interest some people. If not, we can close the PR, no problem.

Fair assessment. I was asking for my knowledge. You are welcome to implement the PR. I bet there are people that don't want to use Docker as a mean of deployment the app

Chiogros · 2022-08-31T15:01:16Z

Great news, thanks!

-h shows a help message with arguments accepted by the script --dev executes script with dev=1, portions of code can change their behavior while looking at dev's value.

Used for better looking while script is running.

Download immich release and extract it in temp directory. If in dev mode, the source code must be in the temp directory.

Configure database with a new password and a new database. The form ask if we want to use an external database, but it is not implemented. Some extensions are required

Services files for each component allows to start them on boot.

Service file to start on boot

All existing sites in /etc/nginx/http.d are disabled, so there are no conflicts for listening on 80 port.

Service file to start ML on boot. The upload folder is a symlink to the server's upload directory

If not in debug mode, the source code and the archive downloaded in the temp directory are deleted. As in debug mode, the source code has been provided, it is not removed.

Chiogros · 2022-09-04T10:59:40Z

There are still a few bugs with Alpine services.
I'm working on.

If flags aren't supported, the ML installation in skipped.

Shell scripts run node commands, these one cannot be managed by services. So when receiving a stop command, child processes are grepped and -kindly- killed. Also environment variables are needed for running server components.

Chiogros · 2022-09-04T19:07:36Z

Hey @alextran1502,

I solved last bugs, you can try it yourself.
If you encounter anything bad or think things different, please tell me, I'll try to do my best.

I tried to implement machine-learning in Alpine.
I better understand why you have not set up machine-learning in an alpine image...

So for the moment, expected for ML, everything seems to work.
ML installation is skipped.

Thanks for your feedback.

panoti · 2022-09-04T19:53:13Z

Hi @Chiogros, your contribution is so interesting. Your scripts are quite readable as well. Would you mind if I give you some questions?

Can we put /web/immich-web, /server/immich-server, /server/immich-microservices, /machine-learning/immich-machine-learning in installation directory like alpine.sh? I found that these files may work only with Alpine OS, especially OpenRC.
Can we fetch alpine_ver directly from current user's OS? As you can see if user try to run your script on another alpine version, it can cause error from package updating.

I also have a plan to create standalone docker image by using PM2. I hope I can re-use your script.

Chiogros · 2022-09-04T20:43:46Z

Hi @panoti,

Can we put /web/immich-web, /server/immich-server, /server/immich-microservices, /machine-learning/immich-machine-learning in installation directory like alpine.sh? I found that these files may work only with Alpine OS, especially OpenRC.

I first thought about the same architecture as you: ./installation/services/openrc/.
In this way, we could then support systemd-based OS by mkdir-ing ./services/systemd/ and translate openrc services to systemd services.

However, every docker images used are alpine images, excepted for ML. Keeping docker/standalone OS the same would certainly be easier to maintain (same packages name, package manager, shell, ...). But it's a way we could try.

Can we fetch alpine_ver directly from current user's OS? As you can see if user try to run your script on another alpine version, it can cause error from package updating.

Yes, it's on my todo-list :)

Thanks!

panoti · 2022-09-05T08:34:25Z

I first thought about the same architecture as you: ./installation/services/openrc/. In this way, we could then support systemd-based OS by mkdir-ing ./services/systemd/ and translate openrc services to systemd services.

I really like this organization because it may help us distinguish between service managers.

However, every docker images used are alpine images, excepted for ML. Keeping docker/standalone OS the same would certainly be easier to maintain (same packages name, package manager, shell, ...). But it's a way we could try.

yeah, but I believe that it will make our source code become mess up if we have more kind of service managers like systemd, sysvinit, ....

Yes, it's on my todo-list :)

Sound great, thank you.

installation/alpine.sh

alextran1502 · 2022-09-07T11:15:02Z

installation/alpine.sh

+
+    # Build stage
+    echo "Installing build stage dependencies..."
+    apk add --no-cache build-base python3 libheif vips-dev ffmpeg nodejs-current npm


is nodejs-current always the lts version of node?

Maybe it is better to perform node installation with the version specified in the Dockerfile to avoid unexpected behavior of the application

pkgs.org gives packages versions for nodejs on different Alpine versions.
The main nodejs package is running node v14, where nodejs-current is running v16, as in Dockerfiles.
Alpine 3.14 is going EOL in a few months, I don't think they will update nodejs-current over v16.
When Dockerfiles's Alpine version will be updated, we will have to look at the right node package compatible with Immich.

alextran1502 · 2022-09-07T11:18:59Z

Thank you for the detail comments in each file. It helps a lot!

I think we want to include an installation script for Debian/Ubuntu as well. What is your plan on this?

Chiogros · 2022-09-07T20:48:55Z

What is your plan on this?

I didn't started anything for Debian/Ubuntu, but I'll start as soon as everything will be okay for Alpine (except ML).

There is one thing and a half to do to support another distro:

find the corresponding packages for its package manager + distro + version
for systemd family, port OpenRC services files (done once)

The longer will be the first one as you can imagine.

web/Dockerfile has been updated, changes have been mirrored in the script.

Partly uninstall and delete immich components, then compile the updated versions.

node user now executes npm commands to set proper permissions on files without having to do chowns again and again. Services files now execute as the node user, a non privilegied user.

Chiogros · 2022-09-08T21:39:09Z

Hi,
I finally managed how to upgrade Immich.
Everything is okay for me, I let you review what have been done since your last feedback.

installation/alpine.sh

An external nginx server can be used. The configuration will not be applied locally, but a warning message will invite to check the repo to see the recommended nginx config.

alextran1502 · 2022-09-11T23:44:58Z

Everything looks good to me. Can you write down some words for the testing procedure and the required environment to test? Thank you for your contribution!

Give tips about script options and development procedures for future releases.

A chown on a symlink without trailing / will not apply on target directory. Also, a note has been added: the storage path should not end with a /.

Chiogros · 2022-09-14T19:39:56Z

Everything looks good to me. Can you write down some words for the testing procedure and the required environment to test? Thank you for your contribution!

Hope it is what you were looking for.
If not, please let me know!

alextran1502 · 2022-09-14T21:16:52Z

@Chiogros Thank you, I will spin up an alpine VM and test then let you know the result. We probably need to move all of the instruction to the WIKI to keep things nice and clean in the readme. It is getting long :P

Chiogros · 2023-01-15T18:28:37Z

Hello everybody,
I finally convinced myself to start a Docker VM.
Good luck to everyone who could want to maintain this script.

Create alpine.sh

3a9c9cf

Chiogros marked this pull request as draft August 31, 2022 12:54

Alexandre Bouijoux added 12 commits September 3, 2022 18:43

Moved docker installation script to installation directory.

1261127

parse_args(), help message and global variables

344b4b2

-h shows a help message with arguments accepted by the script --dev executes script with dev=1, portions of code can change their behavior while looking at dev's value.

display_message_box(), shows a message in a box

f3e847b

Used for better looking while script is running.

update_repo(), enable community repo and update packages list

72e6adc

get_source_code(), download Immich release

f1fb5f3

Download immich release and extract it in temp directory. If in dev mode, the source code must be in the temp directory.

setup_redis(), install and start on boot redis

7887643

setup_database(), install and configure PostgreSQL

a50b082

Configure database with a new password and a new database. The form ask if we want to use an external database, but it is not implemented. Some extensions are required

setup_server(), build and install server & microservices

9309751

Services files for each component allows to start them on boot.

setup_web(), web server

1f3a1b3

Service file to start on boot

setup_proxy(), add new config to Nginx

8faef69

All existing sites in /etc/nginx/http.d are disabled, so there are no conflicts for listening on 80 port.

setup_machine_learning(), build and install everything for ML

be709be

Service file to start ML on boot. The upload folder is a symlink to the server's upload directory

remove_install_files(), remove downloaded code

5cbb573

If not in debug mode, the source code and the archive downloaded in the temp directory are deleted. As in debug mode, the source code has been provided, it is not removed.

Alexandre Bouijoux added 5 commits September 4, 2022 19:34

unset NODE_ENV while compiling machine-learning

ca8b3be

Check for AVX2 flags before installing ML

4f43c10

If flags aren't supported, the ML installation in skipped.

Services manage child processes and load env variables.

62edbc7

Shell scripts run node commands, these one cannot be managed by services. So when receiving a stop command, child processes are grepped and -kindly- killed. Also environment variables are needed for running server components.

--install to start installation and other help messages

a6f5099

Quote database values in env vars

a4deb5b

alextran1502 reviewed Sep 7, 2022

View reviewed changes

installation/alpine.sh Outdated Show resolved Hide resolved

alextran1502 reviewed Sep 7, 2022

View reviewed changes

panoti mentioned this pull request Sep 7, 2022

feat: separate settings for thumbnail and original photo storage locations in .env file #418 #488

Closed

2 tasks

Alexandre Bouijoux added 5 commits September 7, 2022 23:48

Finally, remote DB works.

e28c1d1

1.28 compliant, npm run build in web

e4be609

web/Dockerfile has been updated, changes have been mirrored in the script.

Uninstall function

3f11c6a

--upgrade functionnality

2f7b7eb

Partly uninstall and delete immich components, then compile the updated versions.

Bugfixes, node permissions on files, executed with node.

84fefc3

node user now executes npm commands to set proper permissions on files without having to do chowns again and again. Services files now execute as the node user, a non privilegied user.

Chiogros requested review from panoti and alextran1502 and removed request for panoti and alextran1502 September 8, 2022 21:36

panoti reviewed Sep 9, 2022

View reviewed changes

installation/alpine.sh Show resolved Hide resolved

Alexandre Bouijoux added 6 commits September 10, 2022 12:36

Remote Redis server

f6058c1

Custom DB port

1d06b4d

Support public login page custom message.

598e6ed

Custom hostnames for non-immich services.

557436d

Format help messages

fd402d8

Optional remote nginx server.

c9ceaa3

An external nginx server can be used. The configuration will not be applied locally, but a warning message will invite to check the repo to see the recommended nginx config.

Alexandre Bouijoux added 2 commits September 14, 2022 21:14

Usage and testing procedures.

2ab69d2

Give tips about script options and development procedures for future releases.

Chown not applied on upload symlink.

bd91bcf

A chown on a symlink without trailing / will not apply on target directory. Also, a note has been added: the storage path should not end with a /.

Chiogros closed this Jan 15, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Docker-less Alpine installation #556

Docker-less Alpine installation #556

Chiogros commented Aug 31, 2022

alextran1502 commented Aug 31, 2022

Chiogros commented Aug 31, 2022

alextran1502 commented Aug 31, 2022

Chiogros commented Aug 31, 2022 •

edited

Loading

alextran1502 commented Aug 31, 2022

Chiogros commented Aug 31, 2022

Chiogros commented Sep 4, 2022

Chiogros commented Sep 4, 2022 •

edited

Loading

panoti commented Sep 4, 2022

Chiogros commented Sep 4, 2022

panoti commented Sep 5, 2022

alextran1502 Sep 7, 2022

alextran1502 Sep 7, 2022

Chiogros Sep 7, 2022 •

edited

Loading

alextran1502 commented Sep 7, 2022

Chiogros commented Sep 7, 2022 •

edited

Loading

Chiogros commented Sep 8, 2022

alextran1502 commented Sep 11, 2022

Chiogros commented Sep 14, 2022 •

edited

Loading

alextran1502 commented Sep 14, 2022

Chiogros commented Jan 15, 2023

Docker-less Alpine installation #556

Docker-less Alpine installation #556

Conversation

Chiogros commented Aug 31, 2022

alextran1502 commented Aug 31, 2022

Chiogros commented Aug 31, 2022

alextran1502 commented Aug 31, 2022

Chiogros commented Aug 31, 2022 • edited Loading

alextran1502 commented Aug 31, 2022

Chiogros commented Aug 31, 2022

Chiogros commented Sep 4, 2022

Chiogros commented Sep 4, 2022 • edited Loading

panoti commented Sep 4, 2022

Chiogros commented Sep 4, 2022

panoti commented Sep 5, 2022

alextran1502 Sep 7, 2022

Choose a reason for hiding this comment

alextran1502 Sep 7, 2022

Choose a reason for hiding this comment

Chiogros Sep 7, 2022 • edited Loading

Choose a reason for hiding this comment

alextran1502 commented Sep 7, 2022

Chiogros commented Sep 7, 2022 • edited Loading

Chiogros commented Sep 8, 2022

alextran1502 commented Sep 11, 2022

Chiogros commented Sep 14, 2022 • edited Loading

alextran1502 commented Sep 14, 2022

Chiogros commented Jan 15, 2023

Chiogros commented Aug 31, 2022 •

edited

Loading

Chiogros commented Sep 4, 2022 •

edited

Loading

Chiogros Sep 7, 2022 •

edited

Loading

Chiogros commented Sep 7, 2022 •

edited

Loading

Chiogros commented Sep 14, 2022 •

edited

Loading