docs: polish subscriber install docs

This commit is contained in:
Андрей Бобырев
2026-06-06 01:59:37 +03:00
parent fb89b5b0a5
commit bf306d2e9a
4 changed files with 45 additions and 40 deletions

1
.gitignore vendored
View File

@@ -1,2 +1,3 @@
.env
*.log
.DS_Store

View File

@@ -1,25 +1,25 @@
# Amnezia Web PRO Deploy
Приватный установщик **Amnezia Web PRO** на VPS. Доступ к репозиториям выдаётся подписчикам Boosty.
Приватный установщик **Amnezia Web PRO** на VPS. Доступ выдаётся подписчикам Boosty через private GitHub repo.
По умолчанию установка идёт из private source repo:
Основной сценарий:
- source: `andrey271192/amnezia_web-PRO_test`;
- источник: `andrey271192/amnezia_web-PRO_test`;
- текущий релиз: `v1.5.2`;
- old GHCR image больше не используется по умолчанию;
- legacy GHCR mode оставлен только вручную через `USE_GHCR=1`.
- нужен `GITHUB_TOKEN` с доступом к private repo.
- нужен `GITHUB_TOKEN` с доступом к private repo;
- GHCR больше не используется для обычной установки;
- старый GHCR-режим оставлен только вручную через `USE_GHCR=1`.
## Что делает установщик
- скачивает актуальный `install.sh` из `amnezia_web-PRO_test`;
- скачивает актуальный `install.sh` из private repo;
- ставит Docker, если его нет;
- разворачивает панель в `/opt/amnezia-web-pro`;
- создаёт `.env`;
- собирает и запускает Docker Compose stack;
- поддерживает явный первый пароль admin через `ADMIN_PASSWORD`;
- не требует GHCR PAT для обычной установки;
- требует GitHub token для доступа к private source.
- требует GitHub token для доступа к private repo.
## Быстрая установка
@@ -42,13 +42,13 @@ curl -fsSL -H "Authorization: Bearer ${GITHUB_TOKEN}" \
| sudo -E bash
```
`quick-install.sh` скачает и запустит рабочий установщик:
`quick-install.sh` скачает и запустит основной установщик:
```bash
https://raw.githubusercontent.com/andrey271192/amnezia_web-PRO_test/main/install.sh
```
Если `GITHUB_TOKEN` не передан, private GitHub вернёт `404` или `403`. Это нормально: repo закрыт.
Если `GITHUB_TOKEN` не передан, GitHub вернёт `404` или `403`. Это нормально: repo закрыт.
## Почему больше не GHCR
@@ -64,7 +64,7 @@ ghcr.io/andrey271192/amnezia-admin-pro:v1.0.0
unexpected status ... 403 Forbidden
```
Это не ошибка VPS и не ошибка Docker. Это отказ GitHub Container Registry. Чтобы не ловить эту ошибку у подписчиков, обычная установка теперь идёт из private GitHub source.
Это не ошибка VPS и не ошибка Docker. Это отказ GitHub Container Registry. Чтобы не ловить эту ошибку у подписчиков, обычная установка теперь идёт из private GitHub repo.
Предупреждение Docker:
@@ -76,7 +76,7 @@ WARNING! Your credentials are stored unencrypted in '/root/.docker/config.json'
## Legacy GHCR mode
Оставлен только для ручного использования, если у вас реально есть доступ к package:
Оставлен только для ручного использования, если есть доступ к package:
```bash
export GITHUB_TOKEN='ТОКЕНЗ_BOOSTY'
@@ -103,7 +103,7 @@ USE_GHCR=1 sudo -E bash scripts/install.sh
Причина: старый GHCR-сценарий пытается скачать private image, а у token нет доступа к package.
Решение: используйте обычную private source установку без GHCR:
Решение: используйте обычную установку без GHCR:
```bash
export GITHUB_TOKEN='ТОКЕНЗ_BOOSTY'
@@ -138,7 +138,7 @@ docker info
### `docker compose` не найден
Обычный source installer сам ставит Docker Compose plugin. Если запускаете legacy GHCR mode вручную, обновите Docker/Compose:
Обычный установщик сам ставит Docker Compose plugin. Если запускаете legacy GHCR mode вручную, обновите Docker/Compose:
```bash
sudo apt-get update
@@ -210,10 +210,10 @@ curl -fsSL -H "Authorization: Bearer ${GITHUB_TOKEN}" \
Доступно:
- release channel;
- beta channel;
- стабильный канал;
- beta-канал;
- выбор версии;
- rollback на старый tag.
- откат на старый tag.
Ручное обновление source-установки:

View File

@@ -1,24 +1,28 @@
# Amnezia Web PRO — доступ для подписчиков
# Amnezia Web PRO — закрытый доступ для подписчиков
Amnezia Web PRO теперь в закрытом доступе. Установка и обновления идут через приватный GitHub-доступ для подписчиков.
Отдельно выражаю большую благодарность моим 6 подписчикам на Boosty. Ваша поддержка уже даёт мотивацию дальше дорабатывать проекты, учитывать пожелания людей, убирать баги и исправлять ошибки в работе. Благодаря вам такие инструменты выходят доступными для всех.
Amnezia Web PRO теперь закрыт. Доступ к установке и обновлениям выдаётся подписчикам через приватный GitHub-доступ.
## Что это
## Что внутри
Веб-панель для управления VPN-инфраструктурой на VPS:
- веб-панель для VPN-серверов на VPS;
- серверы через SSH;
- AmneziaWG 2.0, AmneziaWG, AWG Legacy, WireGuard, Xray, Telemt;
- клиенты, пользователи, роли, лимиты, QR и конфиги;
- Cloudflare WARP, AmneziaDNS, AdGuard Home, SOCKS5;
- обновления из GitHub: release, beta, выбор версии и rollback.
- клиенты, пользователи, роли, лимиты, QR-коды и конфиги;
- WARP, AmneziaDNS, AdGuard Home, SOCKS5;
- обновления из GitHub: стабильный канал, beta, выбор версии, откат.
## Важно
## Доступ
Токен нельзя публиковать в чатах, комментариях и скриншотах. Если токен утёк, его нужно отозвать и выдать новый.
Для установки нужен `GITHUB_TOKEN` с доступом к private repo. Токен нельзя публиковать в чатах, комментариях и скриншотах.
Если токен утёк, его нужно отозвать и выдать новый.
## Установка
На свежем VPS с Debian/Ubuntu:
VPS: Debian/Ubuntu, root-доступ.
```bash
export GITHUB_TOKEN='ТОКЕНЗ_BOOSTY'
@@ -29,7 +33,7 @@ curl -fsSL -H "Authorization: Bearer ${GITHUB_TOKEN}" \
| sudo -E bash
```
Если нужен другой порт панели:
Другой порт панели:
```bash
export GITHUB_TOKEN='ТОКЕНЗ_BOOSTY'
@@ -45,9 +49,9 @@ curl -fsSL -H "Authorization: Bearer ${GITHUB_TOKEN}" \
- панель: `http://IP_СЕРВЕРА:25050/panel/`;
- логин: `admin`;
- пароль: тот, который указан в `ADMIN_PASSWORD`.
- пароль: значение `ADMIN_PASSWORD`.
## Обновления
## Обновления и откат
В панели:
@@ -55,8 +59,8 @@ curl -fsSL -H "Authorization: Bearer ${GITHUB_TOKEN}" \
Доступно:
- стабильный канал release;
- beta-канал;
- стабильные релизы;
- beta-версии;
- установка выбранной версии;
- откат на старый tag.
@@ -91,20 +95,20 @@ curl -fsSL -H "Authorization: Bearer ${GITHUB_TOKEN}" \
| sudo REMOVE_DATA=1 REMOVE_DIR=1 bash
```
## Частые проблемы
## Если ошибка
`403 Forbidden` или `404 Not Found` при скачивании:
`403 Forbidden` или `404 Not Found`:
- токен не передан в команду;
- токен не передан;
- токен без доступа к private repo;
- токен отозван;
- подписка/доступ закончились.
- доступ закончился.
`docker login succeeded`, но `pull ghcr.io/...` падает:
- это старый GHCR-сценарий;
- новая установка идёт из private GitHub source;
- GHCR больше не нужен для обычной установки.
- обычная установка теперь идёт из private GitHub source;
- GHCR для обычной установки не нужен.
`WARNING! Your credentials are stored unencrypted`:

View File

@@ -1,6 +1,6 @@
#!/usr/bin/env bash
# One-command installer kept for subscriber links. Default path installs from
# the private source repo using GITHUB_TOKEN, not the legacy GHCR image.
# Установщик для подписчиков. Основной путь ставит из private GitHub repo
# через GITHUB_TOKEN, без legacy GHCR image.
set -euo pipefail
RAW_BASE="${RAW_BASE:-https://raw.githubusercontent.com/andrey271192/amnezia-web-pro-deploy/main}"