Container install and run instructions

[geraveoyomama]

Since I had some trouble installing pathview I want to suggest a containerised method of installation.

Installing prerequisites:

sudo apt install git podman

Clone the repo:

git clone https://github.com/festim-dev/pathview.git
cd pathview

Build the image:

podman build . -t localhost/pathview
podman run -d --replace --name pathview -p 8080:8080 localhost/pathview

Run the image:

podman run -d --replace --name pathview -p 8080:8080 localhost/pathview:latest

If there is interest in this I am open to making a PR but I suspect that the original team is better equipped for integrating these instruction :)

[RemDelaporteMathurin]

Hi @geraveoyomama thank you for this issue! I must admit I don't know podman, how does it compare with docker?

[geraveoyomama]

Its a rather one-for-one drop in replacement.
The main advantage of it for casual users is that it is easily installed because its available by default in the repositories of all major linux distros (updates are easier as well) and windows and mac as well but I've never ran container software on them.
For more advanced users it boasts better default security because of program architecture (no docker socket with root access).
But for this project it doesn't really matter since both will just work.

But the aforementioned instruction can just as well read docker instead of podman :)

[RemDelaporteMathurin]

Ok so then just because I'm more familiar with docker (and I think the rest of the team is as well) I'd like to go for a docker container for now.

I'm very supportive of this and I think it would help some users with installation.

We could also have GitHub actions workflows that build a docker image say at each release and/or nightly and push to DockerHub.

What do you think?

[geraveoyomama]

Sounds like an awesome way to make the project more accesible!
As for containers itself, podman or docker can both run and build OCI containers so whatever is decided on will work for both :)

Also thank you for this project! We are currently using it for our school project :)