Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,47 @@ OpenFlux/
└── build_android.sh # Build the Android client binary
```

### One-shot VPS installer

On Debian/Ubuntu, the exit node can be deployed with the helper script:

```bash
sudo ./scripts/install-vps.sh \
--transport yandex \
--url "https://disk.yandex.ru/i/YOUR_DOCUMENT"
```

The installer uses the repository's existing Docker Compose `exit-node` profile.
The TCP RST suppression rule therefore remains inside the exit-node container's
network namespace and does not affect unrelated host services.

Other transports are supported as well:

```bash
sudo ./scripts/install-vps.sh \
--transport oneme \
--max-token "TOKEN" \
--max-uid "OTHER_SIDE_UID"
```

Useful commands installed on the VPS:

```bash
openflux-health
openflux-status
openflux-log
openflux-update
```

Automatic weekly updates with runtime rollback are opt-in:

```bash
sudo ./scripts/install-vps.sh \
--transport yandex \
--url "https://disk.yandex.ru/i/YOUR_DOCUMENT" \
--enable-auto-update
```

## Build (desktop client / exit-node binary)

```bash
Expand Down
43 changes: 43 additions & 0 deletions README.ru.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,49 @@ OpenFlux/
└── build_android.sh # Сборка клиентского бинарника Android
```

### Установка выходной ноды одной командой

На Debian/Ubuntu выходную ноду можно развернуть вспомогательным скриптом:

```bash
sudo ./scripts/install-vps.sh \
--transport yandex \
--url "https://disk.yandex.ru/i/YOUR_DOCUMENT"
```

Установщик использует существующий Docker Compose-профиль `exit-node` из
репозитория. Поэтому правило подавления TCP RST остаётся внутри сетевого
пространства имён контейнера и не затрагивает другие сервисы хоста.

Поддерживаются и другие транспорты:

```bash
sudo ./scripts/install-vps.sh \
--transport oneme \
--max-token "TOKEN" \
--max-uid "OTHER_SIDE_UID"
```

После установки доступны команды:

```bash
openflux-health
openflux-status
openflux-log
openflux-update
```

Автоматическое еженедельное обновление с откатом при неудачном запуске
включается отдельно:

```bash
sudo ./scripts/install-vps.sh \
--transport yandex \
--url "https://disk.yandex.ru/i/YOUR_DOCUMENT" \
--enable-auto-update
```


## Сборка (бинарник десктоп-клиента / выходной ноды)

```bash
Expand Down
Loading