docs: add quick install script and README section
CI / server (push) Successful in 1m39s
CI / client (push) Successful in 1m23s
CI / version (push) Successful in 7s
CI / image (push) Skipped

- scripts/install.sh prompts for install directory, port and version,
  then writes a compose.yaml using the published registry image and
  creates a data/ directory for the SQLite volume
- README documents a one-line curl | bash install using the script's
  raw URL on the Gitea instance
This commit is contained in:
ars9 committed 2026-10-01 12:20:20 +03:00
1 parent 0341fc2201
commit 2840df68b2
2 files changed
+51

No files matched your search

+39
View File
@@ -0,0 +1,39 @@
#!/usr/bin/env bash
# Installs liqa into a target directory: writes a compose.yaml pulling the
# published image (git.hq.ars9.space/ars9/liqa) and creates ./data for the
# SQLite database, so the install directory needs no copy of this repo.
set -euo pipefail
REGISTRY_IMAGE="git.hq.ars9.space/ars9/liqa"
read -rp "Install directory [./liqa]: " install_dir
install_dir="${install_dir:-./liqa}"
read -rp "Port to expose [13000]: " port
port="${port:-13000}"
read -rp "Version to install [latest]: " version
version="${version:-latest}"
mkdir -p "$install_dir/data"
compose_file="$install_dir/compose.yaml"
cat > "$compose_file" <<EOF
services:
liqa:
image: ${REGISTRY_IMAGE}:${version}
ports:
- "${port}:3000"
env_file:
- path: .env
required: false
volumes:
- ./data:/app/data
restart: unless-stopped
EOF
echo "Wrote $compose_file"
echo "Created $install_dir/data"
echo
echo "To start liqa:"
echo " cd $install_dir && docker compose up -d"