From 11f786366d5170be544c4e11253910604826401f Mon Sep 17 00:00:00 2001 From: CanbiZ <47820557+MickLesk@users.noreply.github.com> Date: Mon, 27 Oct 2025 10:35:29 +0100 Subject: [PATCH] Enhance Ente install script with automation and helpers Adds installation of curl, jq, and the Ente CLI, automates frontend builds with dynamic IP detection, and generates a rebuild script for frontend updates if the IP changes. Updates configuration files to use the container IP, improves post-installation instructions, and creates helper scripts for email verification and subscription upgrades. Also enhances Caddy configuration with CORS headers and provides a detailed final setup summary for easier onboarding. --- install/ente-install.sh | 209 +++++++++++++++++++++++++++++++++++++--- 1 file changed, 193 insertions(+), 16 deletions(-) diff --git a/install/ente-install.sh b/install/ente-install.sh index 8a4b06ab4..9d8d1fcdb 100644 --- a/install/ente-install.sh +++ b/install/ente-install.sh @@ -15,11 +15,13 @@ update_os msg_info "Installing Dependencies" $STD apt-get install -y \ - libsodium23 \ - libsodium-dev \ - pkg-config \ - caddy \ - gcc + libsodium23 \ + libsodium-dev \ + pkg-config \ + caddy \ + gcc \ + curl \ + jq msg_ok "Installed Dependencies" PG_VERSION="17" setup_postgresql @@ -37,10 +39,28 @@ $STD sudo -u postgres psql -c "ALTER ROLE $DB_USER SET client_encoding TO 'utf8' $STD sudo -u postgres psql -c "ALTER ROLE $DB_USER SET default_transaction_isolation TO 'read committed';" $STD sudo -u postgres psql -c "ALTER ROLE $DB_USER SET timezone TO 'UTC';" { - echo "Ente Credentials" - echo "Database Name: $DB_NAME" - echo "Database User: $DB_USER" - echo "Database Password: $DB_PASS" + echo "Ente Credentials" + echo "Database Name: $DB_NAME" + echo "Database User: $DB_USER" + echo "Database Password: $DB_PASS" + echo "" + echo "Important Configuration Notes:" + echo "- Frontend is built with IP: $(hostname -I | awk '{print $1}')" + echo "- If IP changes, run: /opt/ente/rebuild-frontend.sh" + echo "- Museum API: http://$(hostname -I | awk '{print $1}'):8080" + echo "- Photos UI: http://$(hostname -I | awk '{print $1}'):3000" + echo "- Accounts UI: http://$(hostname -I | awk '{print $1}'):3001" + echo "- Auth UI: http://$(hostname -I | awk '{print $1}'):3003" + echo "" + echo "Post-Installation Steps Required:" + echo "1. Create your first user account via the web UI" + echo "2. Check museum logs for email verification code:" + echo " journalctl -u ente-museum -n 100 | grep -i 'verification'" + echo "3. Use verification code to complete account setup" + echo "4. Remove subscription limit (replace with your account):" + echo " ente admin update-subscription -a -u --no-limit" + echo "" + echo "Note: Email verification requires manual intervention since SMTP is not configured" } >>~/ente.creds msg_ok "Set up PostgreSQL" @@ -52,10 +72,10 @@ export CGO_ENABLED=1 CGO_CFLAGS="$(pkg-config --cflags libsodium || true)" CGO_LDFLAGS="$(pkg-config --libs libsodium || true)" if [ -z "$CGO_CFLAGS" ]; then - CGO_CFLAGS="-I/usr/include" + CGO_CFLAGS="-I/usr/include" fi if [ -z "$CGO_LDFLAGS" ]; then - CGO_LDFLAGS="-lsodium" + CGO_LDFLAGS="-lsodium" fi export CGO_CFLAGS export CGO_LDFLAGS @@ -69,6 +89,7 @@ SECRET_JWT=$($STD go run tools/gen-random-keys/main.go | grep "jwt" | awk '{prin msg_ok "Generated Secrets" msg_info "Creating museum.yaml" +CONTAINER_IP=$(hostname -I | awk '{print $1}') cat </opt/ente/server/museum.yaml db: host: 127.0.0.1 @@ -88,9 +109,9 @@ s3: bucket: ente-dev apps: - public-albums: http://localhost:3002 - cast: http://localhost:3004 - accounts: http://localhost:3001 + public-albums: http://${CONTAINER_IP}:3002 + cast: http://${CONTAINER_IP}:3004 + accounts: http://${CONTAINER_IP}:3001 key: encryption: $SECRET_ENC @@ -98,14 +119,25 @@ key: jwt: secret: $SECRET_JWT + +# SMTP not configured - verification codes will appear in logs +# To configure SMTP, add: +# smtp: +# host: your-smtp-server +# port: 587 +# username: your-username +# password: your-password +# email: noreply@yourdomain.com EOF msg_ok "Created museum.yaml" msg_info "Building Web Applications" +# Get container IP address +CONTAINER_IP=$(hostname -I | awk '{print $1}') cd /opt/ente/web $STD yarn install -export NEXT_PUBLIC_ENTE_ENDPOINT=http://localhost:8080 -export NEXT_PUBLIC_ENTE_ALBUMS_ENDPOINT=http://localhost:3002 +export NEXT_PUBLIC_ENTE_ENDPOINT=http://${CONTAINER_IP}:8080 +export NEXT_PUBLIC_ENTE_ALBUMS_ENDPOINT=http://${CONTAINER_IP}:3002 $STD yarn build $STD yarn build:accounts $STD yarn build:auth @@ -115,6 +147,29 @@ cp -r apps/photos/out /var/www/ente/apps/photos cp -r apps/accounts/out /var/www/ente/apps/accounts cp -r apps/auth/out /var/www/ente/apps/auth cp -r apps/cast/out /var/www/ente/apps/cast + +# Save build configuration for future rebuilds +cat </opt/ente/rebuild-frontend.sh +#!/usr/bin/env bash +# Rebuild Ente frontend with current IP +CONTAINER_IP=\$(hostname -I | awk '{print \$1}') +echo "Building frontend with IP: \$CONTAINER_IP" +cd /opt/ente/web +export NEXT_PUBLIC_ENTE_ENDPOINT=http://\${CONTAINER_IP}:8080 +export NEXT_PUBLIC_ENTE_ALBUMS_ENDPOINT=http://\${CONTAINER_IP}:3002 +yarn build +yarn build:accounts +yarn build:auth +yarn build:cast +rm -rf /var/www/ente/apps/* +cp -r apps/photos/out /var/www/ente/apps/photos +cp -r apps/accounts/out /var/www/ente/apps/accounts +cp -r apps/auth/out /var/www/ente/apps/auth +cp -r apps/cast/out /var/www/ente/apps/cast +systemctl reload caddy +echo "Frontend rebuilt successfully!" +REBUILD_EOF +chmod +x /opt/ente/rebuild-frontend.sh msg_ok "Built Web Applications" msg_info "Creating Museum Service" @@ -134,32 +189,96 @@ EOF systemctl enable -q --now ente-museum msg_ok "Created Museum Service" +msg_info "Installing Ente CLI" +ENTE_CLI_VERSION=$(curl -s https://api.github.com/repos/ente-io/ente/releases | jq -r '[.[] | select(.tag_name | startswith("cli-v"))][0].tag_name') +if [ -n "$ENTE_CLI_VERSION" ]; then + ENTE_CLI_URL="https://github.com/ente-io/ente/releases/download/${ENTE_CLI_VERSION}/ente-${ENTE_CLI_VERSION#cli-}-linux-amd64.tar.gz" + $STD curl -fsSL "$ENTE_CLI_URL" -o /tmp/ente-cli.tar.gz + $STD tar -xzf /tmp/ente-cli.tar.gz -C /usr/local/bin + chmod +x /usr/local/bin/ente + rm /tmp/ente-cli.tar.gz + msg_ok "Installed Ente CLI ($ENTE_CLI_VERSION)" +else + msg_warn "Could not determine latest Ente CLI version, skipping CLI installation" +fi + msg_info "Configuring Caddy" +CONTAINER_IP=$(hostname -I | awk '{print $1}') cat </etc/caddy/Caddyfile +# Ente Photos - Main Application :3000 { root * /var/www/ente/apps/photos file_server try_files {path} {path}.html /index.html + + header { + Access-Control-Allow-Origin * + Access-Control-Allow-Methods "GET, POST, PUT, DELETE, OPTIONS" + Access-Control-Allow-Headers * + } } + +# Ente Accounts :3001 { root * /var/www/ente/apps/accounts file_server try_files {path} {path}.html /index.html + + header { + Access-Control-Allow-Origin * + Access-Control-Allow-Methods "GET, POST, PUT, DELETE, OPTIONS" + Access-Control-Allow-Headers * + } } + +# Public Albums :3002 { root * /var/www/ente/apps/photos file_server try_files {path} {path}.html /index.html + + header { + Access-Control-Allow-Origin * + Access-Control-Allow-Methods "GET, POST, PUT, DELETE, OPTIONS" + Access-Control-Allow-Headers * + } } + +# Auth :3003 { root * /var/www/ente/apps/auth file_server try_files {path} {path}.html /index.html + + header { + Access-Control-Allow-Origin * + Access-Control-Allow-Methods "GET, POST, PUT, DELETE, OPTIONS" + Access-Control-Allow-Headers * + } } + +# Cast :3004 { root * /var/www/ente/apps/cast file_server try_files {path} {path}.html /index.html + + header { + Access-Control-Allow-Origin * + Access-Control-Allow-Methods "GET, POST, PUT, DELETE, OPTIONS" + Access-Control-Allow-Headers * + } +} + +# Museum API Proxy +:8080 { + reverse_proxy localhost:8080 + + header { + Access-Control-Allow-Origin * + Access-Control-Allow-Methods "GET, POST, PUT, DELETE, OPTIONS" + Access-Control-Allow-Headers * + } } EOF systemctl reload caddy @@ -168,7 +287,65 @@ msg_ok "Configured Caddy" motd_ssh customize +msg_info "Creating helper scripts" +# Create verification code finder script +cat <<'HELPER_EOF' >/usr/local/bin/ente-get-verification +#!/usr/bin/env bash +echo "Searching for verification codes in museum logs..." +journalctl -u ente-museum --no-pager | grep -i "verification\|verify\|code" | tail -20 +HELPER_EOF +chmod +x /usr/local/bin/ente-get-verification + +# Create subscription upgrade helper +cat <<'HELPER_EOF' >/usr/local/bin/ente-upgrade-subscription +#!/usr/bin/env bash +if [ -z "$1" ]; then + echo "Usage: ente-upgrade-subscription " + echo "Example: ente-upgrade-subscription user@example.com" + exit 1 +fi +EMAIL="$1" +echo "Upgrading subscription for: $EMAIL" +ente admin update-subscription -a "$EMAIL" -u "$EMAIL" --no-limit +HELPER_EOF +chmod +x /usr/local/bin/ente-upgrade-subscription + +msg_ok "Created helper scripts" + msg_info "Cleaning up" $STD apt-get -y autoremove $STD apt-get -y autoclean msg_ok "Cleaned" + +# Final setup summary +CONTAINER_IP=$(hostname -I | awk '{print $1}') +echo -e "\n━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━" +echo -e " ${GN}Ente Installation Complete!${CL}" +echo -e "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━" +echo -e "\n${BL}Access URLs:${CL}" +echo -e " Photos: http://${CONTAINER_IP}:3000" +echo -e " Accounts: http://${CONTAINER_IP}:3001" +echo -e " Auth: http://${CONTAINER_IP}:3003" +echo -e " API: http://${CONTAINER_IP}:8080" +echo -e "\n${YW}⚠️ Important Post-Installation Steps:${CL}" +echo -e "\n${BL}1. Create your first account:${CL}" +echo -e " • Open http://${CONTAINER_IP}:3000 in your browser" +echo -e " • Click 'Sign Up' and create an account" +echo -e "\n${BL}2. Verify your email (required):${CL}" +echo -e " • Run: ${GN}ente-get-verification${CL}" +echo -e " • Look for the verification code in the output" +echo -e " • Enter the code in the web UI to complete registration" +echo -e "\n${BL}3. Remove storage limit:${CL}" +echo -e " • After email verification is complete" +echo -e " • Run: ${GN}ente-upgrade-subscription your@email.com${CL}" +echo -e " • This removes the 10GB limit" +echo -e "\n${BL}4. If IP changes:${CL}" +echo -e " • Run: ${GN}/opt/ente/rebuild-frontend.sh${CL}" +echo -e " • This rebuilds the frontend with the new IP" +echo -e "\n${YW}Known Limitations:${CL}" +echo -e " • Email verification requires checking logs (no SMTP configured)" +echo -e " • Account creation must be done manually via web UI" +echo -e " • Subscription upgrade requires CLI after account creation" +echo -e " • Frontend must be rebuilt if container IP changes" +echo -e "\n${BL}Credentials saved to:${CL} ~/ente.creds" +echo -e "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\n"