docs: add quick install script and README section
- 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:
2 files changed
+51
No files matched your search
@@ -16,6 +16,18 @@ Everything is served from one container at **http://localhost:13000**: the UI at
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
To install liqa from the published image, without cloning this repo:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -fsSL https://git.hq.ars9.space/ars9/liqa/raw/branch/master/scripts/install.sh | bash
|
||||||
|
```
|
||||||
|
|
||||||
|
This asks for an install directory, a port and a version (latest by default), then writes a `compose.yaml` and a `data/` directory there. Start it with `docker compose up -d` in that directory.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
| Concept | Description |
|
| Concept | Description |
|
||||||
|
|||||||
Executable
+39
@@ -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"
|
||||||
Reference in new issue
Block a user