Skip to content

Commit 3991c5a

Browse files
committed
workflow: describe the released assets and how to start the containers
1 parent c7cc3b6 commit 3991c5a

File tree

2 files changed

+55
-14
lines changed

2 files changed

+55
-14
lines changed

README.md

Lines changed: 22 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,11 @@ docker pull ayufan/proxmox-backup-server:latest
3636
docker pull ayufan/proxmox-backup-server:beta
3737
```
3838

39+
Each [GitHub Releases](https://github.com/ayufan/pve-backup-server-dockerfiles/releases) includes the following binary assets:
40+
41+
- `proxmox-backup-server-*.tgz` - contains all archived debian installation files with the `./install` script
42+
- `proxmox-backup-client-*.tgz` - contains a statically linked proxmox backup client
43+
3944
## Run
4045

4146
```bash
@@ -165,30 +170,35 @@ volumes:
165170
device: /srv/pbs/lib
166171
```
167172

168-
## Install on bare-metal host
173+
## Install server on bare-metal or virtualized host
169174

170175
Docker is convienient, but in some cases it might be simply better to install natively.
171-
Since the packages are built against `Debian Buster` your system needs to run soon
172-
to be stable distribution.
173176

174-
You can copy compiled `*.deb` (it will automatically pick `amd64` or `arm64v8` based on your distribution)
175-
from the container and install:
177+
You can pull compiled `*.deb` files from [GitHub Releases](https://github.com/ayufan/pve-backup-server-dockerfiles/releases).
178+
179+
Replace the `v4.0.12` with the latest version.
176180

177181
```bash
178-
cd /tmp
179-
docker run --rm ayufan/proxmox-backup-server:latest tar c /src/ | tar x
180-
apt install $PWD/src/*.deb
182+
wget https://github.com/ayufan/pve-backup-server-dockerfiles/releases/download/v4.0.12/proxmox-backup-server-v4.0.12-$(dpkg --print-architecture).tgz
183+
tar zxf proxmox-backup-server-*.tgz
184+
proxmox-backup-server-*/install
181185
```
182186

183-
## Recompile latest version or master
187+
## Use static client binary
184188

185-
Refer to [PROCESS.md](PROCESS.md).
189+
Similar to server, the client binary is available for various architectures. The `arm32` is considered unstable, and should only be able to backup, but likely cannot be used to restore data.
190+
191+
```bash
192+
wget https://github.com/ayufan/pve-backup-server-dockerfiles/releases/download/v4.0.12/proxmox-backup-client-v4.0.12-$(dpkg --print-architecture).tgz
193+
tar zxf proxmox-backup-client-*.tgz
194+
proxmox-backup-client-*/proxmox-backup-client.sh
195+
```
186196

187-
## Build on your own
197+
## Build on your own / Recompile latest version or master
188198

189199
Refer to [PROCESS.md](PROCESS.md).
190200

191201
## Author
192202

193-
This is just built by Kamil Trzciński, 2020-2023
203+
This is just built by Kamil Trzciński, 2020-2025
194204
from the sources found on http://git.proxmox.com/.

RELEASE.md

Lines changed: 33 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,41 @@
44

55
If you found it useful :)
66

7-
## Use it
7+
## Use docker image
88

99
For starting quickly all images are precompiled and hosted at https://hub.docker.com/r/ayufan/proxmox-backup-server/tags.
1010

11-
```
11+
```bash
1212
docker pull ayufan/proxmox-backup-server:#{GIT_TAG_NAME}
1313
```
14+
15+
## Run as a docker container
16+
17+
```bash
18+
wget https://raw.githubusercontent.com/ayufan/pve-backup-server-dockerfiles/refs/heads/master/docker-compose.yml
19+
TAG=#{GIT_TAG_NAME} docker-compose up -d
20+
```
21+
22+
Adapt `docker-compose.yml` to your environment,
23+
and re-run the `TAG=#{GIT_TAG_NAME} docker-compose up -d`.
24+
25+
Then login to `https://<ip>:8007/` with `admin / pbspbs`.
26+
After that change a password.
27+
28+
## Install server on bare-metal or virtualized host
29+
30+
```bash
31+
wget https://github.com/ayufan/pve-backup-server-dockerfiles/releases/download/#{GIT_TAG_NAME}/proxmox-backup-server-#{GIT_TAG_NAME}-$(dpkg --print-architecture).tgz
32+
tar zxf proxmox-backup-server-*.tgz
33+
proxmox-backup-server-*/install
34+
```
35+
36+
## Use static client binary
37+
38+
Similar to server, the client binary is available for various architectures. The `arm32` is considered unstable, and should only be able to backup, but likely cannot be used to restore data.
39+
40+
```bash
41+
wget https://github.com/ayufan/pve-backup-server-dockerfiles/releases/download/v4.0.12/proxmox-backup-client-#{GIT_TAG_NAME}-$(dpkg --print-architecture).tgz
42+
tar zxf proxmox-backup-client-*.tgz
43+
proxmox-backup-client-*/proxmox-backup-client.sh
44+
```

0 commit comments

Comments
 (0)