diff --git a/photoprism/CHANGELOG.md b/photoprism/CHANGELOG.md new file mode 100644 index 000000000..66f7e8b76 --- /dev/null +++ b/photoprism/CHANGELOG.md @@ -0,0 +1 @@ +- Initial release diff --git a/photoprism/Dockerfile b/photoprism/Dockerfile new file mode 100644 index 000000000..a42f070c3 --- /dev/null +++ b/photoprism/Dockerfile @@ -0,0 +1,81 @@ +ARG BUILD_FROM +ARG BUILD_VERSION +ARG BUILD_UPSTREAM="preview" +FROM photoprism/photoprism:preview + +# Copy root filesystem +COPY rootfs / + +ARG BASHIO_VERSION=0.13.0 + +RUN \ + ################ + # Install apps # + ################ + apt-get update \ + && apt-get install -y \ + jq \ + curl \ + cifs-utils \ + keyutils \ + samba \ + coreutils \ + \ + ################## + # Install bashio # + ################## + && mkdir -p /tmp/bashio \ + && curl -L -f -s "https://github.com/hassio-addons/bashio/archive/v${BASHIO_VERSION}.tar.gz" \ + | tar -xzf - --strip 1 -C /tmp/bashio \ + && mv /tmp/bashio/lib /usr/lib/bashio \ + && ln -s /usr/lib/bashio/bashio /usr/bin/bashio \ + && rm -rf /tmp/bashio \ + \ + /var/{cache,log}/* \ + /var/lib/apt/lists/* \ + \ + ################### + # Configure image # + ################### + \ + # Create directories + && mkdir -m 777 -p \ + /data/photoprism/originals \ + /data/photoprism/import \ + /data/photoprism/storage/config \ + /data/photoprism/backup \ + /data/photoprism/storage/cache && \ + chown -Rf photoprism:photoprism /data/photoprism && \ + chmod -Rf a+rwx /data/photoprism \ + # Allow execution of run + && chmod 777 /run.sh + +ENTRYPOINT [ "/usr/bin/env" ] +CMD [ "/run.sh" ] + +### LABELS +ARG BUILD_ARCH +ARG BUILD_DATE +ARG BUILD_DESCRIPTION +ARG BUILD_NAME +ARG BUILD_REF +ARG BUILD_REPOSITORY +ARG BUILD_VERSION +LABEL \ + io.hass.name="${BUILD_NAME}" \ + io.hass.description="${BUILD_DESCRIPTION}" \ + io.hass.arch="${BUILD_ARCH}" \ + io.hass.type="addon" \ + io.hass.version=${BUILD_VERSION} \ + maintainer="alexbelgium (https://github.com/alexbelgium)" \ + org.opencontainers.image.title="${BUILD_NAME}" \ + org.opencontainers.image.description="${BUILD_DESCRIPTION}" \ + org.opencontainers.image.vendor="Home Assistant Add-ons" \ + org.opencontainers.image.authors="alexbelgium (https://github.com/alexbelgium)" \ + org.opencontainers.image.licenses="MIT" \ + org.opencontainers.image.url="https://github.com/alexbelgium" \ + org.opencontainers.image.source="https://github.com/${BUILD_REPOSITORY}" \ + org.opencontainers.image.documentation="https://github.com/${BUILD_REPOSITORY}/blob/main/README.md" \ + org.opencontainers.image.created=${BUILD_DATE} \ + org.opencontainers.image.revision=${BUILD_REF} \ + org.opencontainers.image.version=${BUILD_VERSION} diff --git a/photoprism/README.md b/photoprism/README.md new file mode 100644 index 000000000..d59a164a5 --- /dev/null +++ b/photoprism/README.md @@ -0,0 +1,43 @@ +# Home assistant add-on: Photoprism + +![Supports aarch64 Architecture][aarch64-shield] ![Supports amd64 Architecture][amd64-shield] ![Supports armhf Architecture][armhf-shield] ![Supports armv7 Architecture][armv7-shield] + +MINIMUM CONFIG REQUIRED : 2 cores and 4 GB of memory + +## About + +A server-based application for browsing, organizing and sharing your personal photo collection. + +Project homepage : https://github.com/photoprism/photoprism + +Based on the docker image : https://hub.docker.com/r/photoprism/photoprism + +## Installation + +The installation of this add-on is pretty straightforward and not different in +comparison to installing any other Hass.io add-on. + +1. [Add my Hass.io add-ons repository][repository] to your Hass.io instance. +1. Install this add-on. +1. Click the `Save` button to store your configuration. +1. Start the add-on. +1. Check the logs of the add-on to see if everything went well. +1. Carefully configure the add-on to your preferences, see the official documentation for for that. + +## Configuration + +Webui can be found at . + +## Support + +Create an issue on github + +[repository]: https://github.com/alexbelgium/hassio-addons +[smb-shield]: https://img.shields.io/badge/smb-yes-green.svg +[openvpn-shield]: https://img.shields.io/badge/openvpn-yes-green.svg +[ingress-shield]: https://img.shields.io/badge/ingress-yes-green.svg +[ssl-shield]: https://img.shields.io/badge/ssl-yes-green.svg +[aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg +[amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg +[armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg +[armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg diff --git a/photoprism/apparmor.txt b/photoprism/apparmor.txt new file mode 100644 index 000000000..ae1fcbb1c --- /dev/null +++ b/photoprism/apparmor.txt @@ -0,0 +1,49 @@ +#include + +profile photoprism flags=(attach_disconnected,mediate_deleted) { + #include + + capability, + file, + mount, + umount, + remount, + + capability setgid, + capability setuid, + capability sys_admin, + capability dac_read_search, + capability dac_override, + capability sys_rawio, + +# S6-Overlay + /bin/** ix, + /usr/bin/** ix, + /usr/lib/bashio/** ix, + /etc/s6/** rix, + /run/s6/** rix, + /etc/services.d/** rwix, + /etc/cont-init.d/** rwix, + /etc/cont-finish.d/** rwix, + /init rix, + /var/run/** mrwkl, + /var/run/ mrwkl, + /dev/i2c-1 mrwkl, + # Files required + /dev/sda1 mrwkl, + /dev/sdb1 mrwkl, + /dev/mmcblk0p1 mrwkl, + /dev/ttyUSB0 mrwkl, + /dev/* mrwkl, + /tmp/** mrkwl, + + # Data access + /data/** rw, + + # suppress ptrace denials when using 'docker ps' or using 'ps' inside a container + ptrace (trace,read) peer=docker-default, + + # docker daemon confinement requires explict allow rule for signal + signal (receive) set=(kill,term) peer=/usr/bin/docker, + +} diff --git a/photoprism/config.json b/photoprism/config.json new file mode 100644 index 000000000..532d5b4f0 --- /dev/null +++ b/photoprism/config.json @@ -0,0 +1,39 @@ +{ + "name": "Photoprism", + "version": "0.1", + "upstream": "preview", + "slug": "photoprism", + "description": "A server-based application for browsing, organizing and sharing your personal photo collection", + "url": "https://github.com/alexbelgium/hassio-addons-test", + "webui": "http://[HOST]:[PORT:2342]", + "ports": { + "2342/tcp": 2342 + }, + "apparmor": "true", + "privileged": ["SYS_ADMIN", "DAC_READ_SEARCH"], + "ports_description": { + "2342/tcp": "Web interface" + }, + "map": ["media:rw", "share:rw"], + "full_access": true, + "environment": { + "PHOTOPRISM_UPLOAD_NSFW": "true", + "PHOTOPRISM_STORAGE_PATH": "/data/photoprism/storage", + "PHOTOPRISM_ORIGINALS_PATH": "/data/photoprism/originals", + "PHOTOPRISM_IMPORT_PATH": "/data/photoprism/import", + "PHOTOPRISM_BACKUP_PATH": "/data/photoprism/backup", + "PHOTOPRISM_ADMIN_PASSWORD": "please_change_password" + }, + "options": { + "networkdisks": "//server/share", + "cifsusername": "username", + "cifspassword": "password" + }, + "schema": { + "localdisks": "str?", + "networkdisks": "str?", + "cifsusername": "str?", + "cifspassword": "str?" + }, + "arch": ["aarch64", "amd64", "armhf", "armv7"] +} diff --git a/photoprism/icon.png b/photoprism/icon.png new file mode 100644 index 000000000..e8d68d353 Binary files /dev/null and b/photoprism/icon.png differ diff --git a/photoprism/logo.png b/photoprism/logo.png new file mode 100644 index 000000000..e8d68d353 Binary files /dev/null and b/photoprism/logo.png differ diff --git a/photoprism/rootfs/run.sh b/photoprism/rootfs/run.sh new file mode 100644 index 000000000..1bdb7e156 --- /dev/null +++ b/photoprism/rootfs/run.sh @@ -0,0 +1,134 @@ +#!/usr/bin/env bashio + +bashio::log.warning "Warning - minimum configuration required: 2 cpu cores and 4 GB of memory" + +########## +# BANNER # +########## + +if bashio::supervisor.ping; then + bashio::log.blue \ + '-----------------------------------------------------------' + bashio::log.blue " Add-on: $(bashio::addon.name)" + bashio::log.blue " $(bashio::addon.description)" + bashio::log.blue \ + '-----------------------------------------------------------' + + bashio::log.blue " Add-on version: $(bashio::addon.version)" + if bashio::var.true "$(bashio::addon.update_available)"; then + bashio::log.magenta ' There is an update available for this add-on!' + bashio::log.magenta \ + " Latest add-on version: $(bashio::addon.version_latest)" + bashio::log.magenta ' Please consider upgrading as soon as possible.' + else + bashio::log.green ' You are running the latest version of this add-on.' + fi + + bashio::log.blue " System: $(bashio::info.operating_system)" \ + " ($(bashio::info.arch) / $(bashio::info.machine))" + bashio::log.blue " Home Assistant Core: $(bashio::info.homeassistant)" + bashio::log.blue " Home Assistant Supervisor: $(bashio::info.supervisor)" + + bashio::log.blue \ + '-----------------------------------------------------------' + bashio::log.blue \ + ' Please, share the above information when looking for help' + bashio::log.blue \ + ' or support in, e.g., GitHub, forums or the Discord chat.' + bashio::log.green \ + ' https://github.com/alexbelgium/hassio-addons' + bashio::log.blue \ + '-----------------------------------------------------------' +fi + +###################### +# MOUNT LOCAL SHARES # +###################### + +# Mount local Share if configured and if Protection Mode is active +if bashio::config.has_value 'localdisks'; then + bashio::log.info 'Mounting local hdd...' + bashio::require.unprotected + MOREDISKS=$(bashio::config 'localdisks') + bashio::log.info "Local Disks mounting.. ${MOREDISKS}" && \ + for disk in ${MOREDISKS//,/ }; do # Separate comma separated values + bashio::log.info "Mount ${disk}" + mkdir -p /share/$disk && \ + if [ ! -d /share/$disk ]; then + echo "Creating /share/$disk" + mkdir -p /share/$disk + chown -R abc:abc /share/$disk + fi + mount /dev/$disk /share/$disk && \ + bashio::log.info "Success!" + done || \ + bashio::log.warning "Protection mode is ON. Unable to mount local drives!" +fi || true + +#################### +# MOUNT SMB SHARES # +#################### +if bashio::config.has_value 'networkdisks'; then + # Mount CIFS Share if configured and if Protection Mode is active + bashio::log.info 'Mounting smb share(s)...' + + # Define variables + MOREDISKS=$(bashio::config 'networkdisks') + CIFS_USERNAME=$(bashio::config 'cifsusername') + CIFS_PASSWORD=$(bashio::config 'cifspassword') + MOUNTED=false + SMBVERS="" + SECVERS="" + + if bashio::config.has_value 'cifsdomain'; then + DOMAIN=",domain=$(bashio::config 'cifsdomain')" + else + DOMAIN="" + fi + + # Mounting disks + for disk in ${MOREDISKS//,/ }; do # Separate comma separated values + # Clean name of network share + disk=$(echo $disk | sed "s,/$,,") # Remove / at end of name + diskname=${disk//\\//} #replace \ with / + diskname=${diskname##*/} # Get only last part of the name + # Prepare mount point + mkdir -p /mnt/$diskname + chown -R root:root /mnt/$diskname + + #Tries to mount with default options + mount -t cifs -o rw,username=$CIFS_USERNAME,password=${CIFS_PASSWORD}$DOMAIN $disk /mnt/$diskname 2>ERRORCODE && MOUNTED=true || MOUNTED=false + + # if Fail test different smb and sec versions + if [ $MOUNTED = false ]; then + for SMBVERS in ",vers=3" ",vers=1.0" ",vers=2.1" ",vers=3.0" ",nodfs" ",uid=0,gid=0,forceuid,forcegid" ",noforceuid,noforcegid" ",${DOMAIN}"; do + mount -t cifs -o rw,iocharset=utf8,file_mode=0777,dir_mode=0777,username=$CIFS_USERNAME,password=${CIFS_PASSWORD}$SMBVERS $disk /mnt/$diskname 2>/dev/null && MOUNTED=true && break || MOUNTED=false + for SECVERS in ",sec=ntlmi" ",sec=ntlmv2" ",sec=ntlmv2i" ",sec=ntlmssp" ",sec=ntlmsspi" ",sec=ntlm" ",sec=krb5i" ",sec=krb5"; do + mount -t cifs -o rw,iocharset=utf8,file_mode=0777,dir_mode=0777,username=$CIFS_USERNAME,password=${CIFS_PASSWORD}$SMBVERS$SECVERS $disk /mnt/$disk name 2>/dev/null && MOUNTED=true && break 2 && break || MOUNTED=false + done + done + fi + + # Messages + if [ $MOUNTED = true ]; then + #Test write permissions + touch /mnt/$diskname/testaze && rm /mnt/$diskname/testaze && bashio::log.info "... $disk successfully mounted to /mnt/$diskname with options $SMBVERS$SECVERS" || bashio::log.fatal "Disk is mounted, however unable to write in the shared disk. Please check UID/GID for permissions, and if the share is rw" + else + # message if still fail + bashio::log.fatal "Unable to mount $disk to /mnt/$diskname with username $CIFS_USERNAME, $CIFS_PASSWORD. Please check your remote share path, username, password, domain, try putting 0 in UID and GID" # Mount share + bashio::log.fatal "Error read : $(