diff --git a/README.md b/README.md index 8651ed9..51f2439 100644 --- a/README.md +++ b/README.md @@ -22,10 +22,39 @@ Base URL: **https://gitea.linuxiarz.pl/gru/npm-angie-auto-install** ## Quick Start (one-liner) ```bash -curl -fsSL https://gitea.linuxiarz.pl/gru/npm-angie-auto-install/raw/branch/master/npm_install.py -o install.py && sudo python3 install.py --dark-mode +curl -fsSL https://gitea.linuxiarz.pl/gru/npm-angie-auto-install/raw/branch/master/npm_install.py -o install.py && sudo python3 install.py --dark-mode ``` -> If you keep a patched version, replace `install.py` with your file name (e.g. `install_fixed.py`). +## Options / Help + +```bash +usage: install.py [-h] [--nodejs-pkg NODEJS_PKG] [--node-version NODE_VERSION] [--npm-version NPM_VERSION] [--motd {yes,no}] [--enable-ipv6] [--update] [--dark-mode] + [--tp-domain TP_DOMAIN] [--tp-community-theme TP_COMMUNITY_THEME] [--tp-scheme TP_SCHEME] [--tp-theme TP_THEME] [--debug] + +Install/upgrade NPM on Angie (Debian/Ubuntu) with step animation. + +options: + -h, --help show this help message and exit + --nodejs-pkg NODEJS_PKG + APT Node.js package name (e.g. nodejs, nodejs-18). (default: nodejs) + --node-version NODE_VERSION + Install Node.js from NodeSource repo (e.g. 'latest', '22', '20', '18'). Overrides --nodejs-pkg. (default: None) + --npm-version NPM_VERSION + Force NPM app version (e.g. 2.12.6). Default: latest release. (default: None) + --motd {yes,no} Update MOTD after completion. (default: yes) + --enable-ipv6 Do not strip IPv6 from configs/resolvers (keep IPv6). (default: False) + --update Update mode: upgrade packages + rebuild frontend/backend without reconfiguring Angie. (default: False) + --dark-mode Inject Theme.Park CSS into frontend (see TP_* vars). (default: False) + --tp-domain TP_DOMAIN + Theme.Park domain (e.g. theme-park.dev or *.github.io). (default: ) + --tp-community-theme TP_COMMUNITY_THEME + true = community-theme-options; false = theme-options. (default: false) + --tp-scheme TP_SCHEME + URL scheme (http/https). (default: https) + --tp-theme TP_THEME Theme.Park theme name (e.g. organizr, catppuccin). (default: organizr) + --debug Show detailed logs and progress. (default: False) + +``` --- @@ -66,8 +95,10 @@ systemctl status angie.service --no-pager systemctl status npm.service --no-pager ``` # NPM UI -# Default: http(s)://:81 (see summary printed by installer) +# Default: http://:81 +# Angie UI +# Default: http://:82 ---