Better Installation Instructions

[intellifos]

The project looks perfect for my use-case, although I have a little trouble in understanding how to install and use it.

The docker example or git cloning it and deployment in a vps, it seems a little vague. Would appreciate step-by-step instructions.

Thanks!

[gbbirkisson]

Sounds reasonable. I kinda assumed that people would just study the Dockerfile if they wanted to understand how this works, but thats not very user friendly. I will try to find some time to write proper docs.

[gbbirkisson]

I updated the README and added some examples. You think this is sufficient?

[gbbirkisson]

Closing this since I have had no reply

[nettyso]

Hi @gbbirkisson sorry to ping an old thread here but do you have any additional steps needed to make it work? I don't see any errors in logs (as seen in issue #90) there's simply...nothing!

podman run -it --name spis --replace -p 8080:8080  -v /home/netty/Photos_Oct_11_2024:/var/lib/spis/media:Z  -v /home/netty/SPIS_DATA:/var/lib/spis/data:Z ghcr.io/gbbirkisson/spis

Logs:

2024-10-11 08:45:37,475 INFO Set uid to user 0 succeeded
2024-10-11 08:45:37,475 INFO supervisord started with pid 1
2024-10-11 08:45:38,477 INFO spawned: 'nginx' with pid 2
2024-10-11 08:45:38,478 INFO spawned: 'spis' with pid 3
2024-10-11T08:45:38.481011Z  INFO spis: Starting spis version 0.8.1
2024-10-11T08:45:38.481019Z  INFO spis: Media dir: "/var/lib/spis/media"
2024-10-11T08:45:38.481021Z  INFO spis: Thumb dir: "/var/lib/spis/data/thumbnails"
2024-10-11T08:45:38.481022Z  INFO spis: Data file: "/var/lib/spis/data/spis.db"
2024-10-11T08:45:38.481023Z  INFO spis: Setting up DB
/docker-entrypoint.sh: /docker-entrypoint.d/ is not empty, will attempt to perform configuration
/docker-entrypoint.sh: Looking for shell scripts in /docker-entrypoint.d/
2024-10-11T08:45:38.481509Z  INFO spis: Setting up media processing
2024-10-11T08:45:38.481867Z  INFO spis: Setting up file watcher
/docker-entrypoint.sh: Launching /docker-entrypoint.d/10-listen-on-ipv6-by-default.sh
10-listen-on-ipv6-by-default.sh: info: Getting the checksum of /etc/nginx/conf.d/default.conf
10-listen-on-ipv6-by-default.sh: info: Enabled listen on IPv6 in /etc/nginx/conf.d/default.conf
/docker-entrypoint.sh: Sourcing /docker-entrypoint.d/15-local-resolvers.envsh
/docker-entrypoint.sh: Launching /docker-entrypoint.d/20-envsubst-on-templates.sh
/docker-entrypoint.sh: Launching /docker-entrypoint.d/30-tune-worker-processes.sh
/docker-entrypoint.sh: Launching /docker-entrypoint.d/40-nginx-user-fix.sh
/docker-entrypoint.sh: Launching /docker-entrypoint.d/50-config-override.sh
/docker-entrypoint.sh: Configuration complete; ready for start up
2024/10/11 08:45:38 [notice] 2#2: using the "epoll" event method
2024/10/11 08:45:38 [notice] 2#2: nginx/1.27.2
2024/10/11 08:45:38 [notice] 2#2: built by gcc 12.2.0 (Debian 12.2.0-14) 
2024/10/11 08:45:38 [notice] 2#2: OS: Linux 6.11.0-400.asahi.fc40.aarch64+16k
2024/10/11 08:45:38 [notice] 2#2: getrlimit(RLIMIT_NOFILE): 524288:524288
2024/10/11 08:45:38 [notice] 2#2: start worker processes
2024/10/11 08:45:38 [notice] 2#2: start worker process 69
2024/10/11 08:45:38 [notice] 2#2: start worker process 70
2024/10/11 08:45:38 [notice] 2#2: start worker process 71
2024/10/11 08:45:38 [notice] 2#2: start worker process 72
2024/10/11 08:45:38 [notice] 2#2: start worker process 73
2024/10/11 08:45:38 [notice] 2#2: start worker process 74
2024/10/11 08:45:38 [notice] 2#2: start worker process 75
2024/10/11 08:45:38 [notice] 2#2: start worker process 76
2024/10/11 08:45:38 [notice] 2#2: start worker process 77
2024/10/11 08:45:38 [notice] 2#2: start worker process 78
2024/10/11 08:45:38 [notice] 2#2: start worker process 79
2024/10/11 08:45:38 [notice] 2#2: start worker process 80
2024-10-11T08:45:38.501941Z  INFO spis: Setting up file walker
2024-10-11T08:45:38.501978Z  INFO spis::pipeline: Starting db processing component
2024-10-11T08:45:38.501992Z  INFO spis: Start listening on socket /var/lib/spis/data/spis.sock
2024-10-11T08:45:38.501994Z  INFO spis::pipeline: Added processing schedule: 0 0 2 * * *
2024-10-11 08:45:39,503 INFO success: nginx entered RUNNING state, process has stayed up for > than 1 seconds (startsecs)
2024-10-11 08:45:39,503 INFO success: spis entered RUNNING state, process has stayed up for > than 1 seconds (startsecs)

The process is chilling, no work being done. There's 51.1GB of photos.

If I enter the container via exec -it bash and manually run spis process I get

# spis process
2024-10-11T08:48:22.207973Z  WARN spis::pipeline: file_channel was closed

It's only a WARN though, so...

Any help is appreciated! Thanks :)