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
42 changes: 42 additions & 0 deletions README.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -196,6 +196,48 @@ sudo journalctl -u cpa-usage-keeper -f # Follow service logs.
sudo systemctl restart cpa-usage-keeper # Restart the service.
```

## Arch Linux (AUR)

Arch Linux users can install the prebuilt package from the AUR ([cpa-usage-keeper-bin](https://aur.archlinux.org/packages/cpa-usage-keeper-bin)):

```bash
yay -S cpa-usage-keeper-bin
```

The AUR package uses a user-level systemd service and stores its configuration under the current user account:

```bash
install -Dm600 \
/usr/share/doc/cpa-usage-keeper-bin/cpa-usage-keeper.env.example \
~/.config/cpa-usage-keeper/cpa-usage-keeper.env

vim ~/.config/cpa-usage-keeper/cpa-usage-keeper.env
systemctl --user daemon-reload
systemctl --user enable --now cpa-usage-keeper.service
```

At minimum, set `CPA_BASE_URL` and `CPA_MANAGEMENT_KEY`. CPA must publish usage events, so enable `usage-statistics-enabled: true` in the CLIProxyAPI config. If `APP_PORT` conflicts with another local service, change it in the config file.

The SQLite database, logs, and backups are stored by default in:

```text
~/.local/state/cpa-usage-keeper/
```

Useful commands:

```bash
systemctl --user status cpa-usage-keeper.service
journalctl --user -u cpa-usage-keeper.service -f
systemctl --user restart cpa-usage-keeper.service
```

To keep the user service running without an active login session, enable linger:

```bash
loginctl enable-linger "$USER"
```

## Docker

If CPA is already running on the host:
Expand Down
42 changes: 42 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -196,6 +196,48 @@ sudo journalctl -u cpa-usage-keeper -f # 实时查看服务日志
sudo systemctl restart cpa-usage-keeper # 重启服务
```

## Arch Linux(AUR)

Arch Linux 用户可以通过 AUR 安装预编译包([cpa-usage-keeper-bin](https://aur.archlinux.org/packages/cpa-usage-keeper-bin)):

```bash
yay -S cpa-usage-keeper-bin
```

AUR 包使用 user-level systemd 服务,配置文件放在当前用户目录下:

```bash
install -Dm600 \
/usr/share/doc/cpa-usage-keeper-bin/cpa-usage-keeper.env.example \
~/.config/cpa-usage-keeper/cpa-usage-keeper.env

vim ~/.config/cpa-usage-keeper/cpa-usage-keeper.env
systemctl --user daemon-reload
systemctl --user enable --now cpa-usage-keeper.service
```

请至少设置 `CPA_BASE_URL` 和 `CPA_MANAGEMENT_KEY`。CPA 侧需要启用 `usage-statistics-enabled: true` 才会发布 usage 事件。如果 `APP_PORT` 与本机其它服务冲突,也可以在配置文件中改成其它端口。

SQLite 数据库、日志和备份默认存放在:

```text
~/.local/state/cpa-usage-keeper/
```

常用命令:

```bash
systemctl --user status cpa-usage-keeper.service
journalctl --user -u cpa-usage-keeper.service -f
systemctl --user restart cpa-usage-keeper.service
```

如果需要在没有活动登录会话时也自动运行用户服务,请启用 linger:

```bash
loginctl enable-linger "$USER"
```

## Docker

如果 CPA 已在宿主机运行:
Expand Down
Loading