Skip to content

Commit 9bbf05b

Browse files
authored
enh: rename image for better discoverability (#8)
* enh: rename image for better discoverability
1 parent 2d9a40b commit 9bbf05b

File tree

3 files changed

+20
-20
lines changed

3 files changed

+20
-20
lines changed

.github/workflows/publish.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,9 @@ jobs:
2929
uses: actions/cache@v3
3030
with:
3131
path: /tmp/.buildx-cache
32-
key: aa-docker-socket-proxy-buildx-${{ github.sha }}
32+
key: nextcloud-appapi-dsp-buildx-${{ github.sha }}
3333
restore-keys: |
34-
aa-docker-socket-proxy-buildx-
34+
nextcloud-appapi-dsp-buildx-
3535
3636
- name: Log in to GitHub Container Registry
3737
uses: docker/login-action@v3
@@ -50,7 +50,7 @@ jobs:
5050
context: .
5151
platforms: linux/amd64
5252
file: Dockerfile
53-
tags: aa-docker-socket-proxy:${{ github.sha }}
53+
tags: nextcloud-appapi-dsp:${{ github.sha }}
5454
load: true
5555
cache-from: type=local,src=/tmp/.buildx-cache
5656
cache-to: type=local,dest=/tmp/.buildx-cache-new
@@ -75,8 +75,8 @@ jobs:
7575
platforms: linux/amd64,linux/arm64
7676
file: Dockerfile
7777
tags: |
78-
ghcr.io/cloud-py-api/aa-docker-socket-proxy:${{ github.event_name == 'release' && 'release' || 'latest' }}
79-
ghcr.io/cloud-py-api/aa-docker-socket-proxy:${{ github.ref_name }}
78+
ghcr.io/cloud-py-api/nextcloud-appapi-dsp:${{ github.event_name == 'release' && 'release' || 'latest' }}
79+
ghcr.io/cloud-py-api/nextcloud-appapi-dsp:${{ github.ref_name }}
8080
cache-from: type=local,src=/tmp/.buildx-cache
8181
cache-to: type=local,dest=/tmp/.buildx-cache-new
8282
- name: Move cache

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ We highly recommend to use it **in all cases**, except for **Nextcloud AIO**, in
2121
```shell
2222
docker run -e NC_HAPROXY_PASSWORD="some_secure_password" \
2323
-v /var/run/docker.sock:/var/run/docker.sock \
24-
--name aa-docker-socket-proxy -h aa-docker-socket-proxy \
25-
--restart unless-stopped --privileged -d ghcr.io/cloud-py-api/aa-docker-socket-proxy:release
24+
--name nextcloud-appapi-dsp -h nextcloud-appapi-dsp \
25+
--restart unless-stopped --privileged -d ghcr.io/cloud-py-api/nextcloud-appapi-dsp:release
2626
```
2727

2828
Instead of `some_secure_password` you put your password that later you should provide to AppAPI during Daemon creation.
@@ -36,8 +36,8 @@ docker run -e NC_HAPROXY_PASSWORD="some_secure_password" \
3636
-e BIND_ADDRESS="x.y.z.z"
3737
-v /var/run/docker.sock:/var/run/docker.sock \
3838
-v `pwd`/certs/cert.pem:/certs/cert.pem \
39-
--name aa-docker-socket-proxy -h aa-docker-socket-proxy --net host \
40-
--restart unless-stopped --privileged -d ghcr.io/cloud-py-api/aa-docker-socket-proxy:release
39+
--name nextcloud-appapi-dsp -h nextcloud-appapi-dsp --net host \
40+
--restart unless-stopped --privileged -d ghcr.io/cloud-py-api/nextcloud-appapi-dsp:release
4141
```
4242

4343
Here in addition we map certificate file from host with SSL certificate that will be used by HaProxy and specify to use the `host` network.
@@ -69,27 +69,27 @@ You should set `BIND_ADDRESS` to the IP on which server with ExApps can accept r
6969
To build image locally use:
7070

7171
```shell
72-
docker build -f ./Dockerfile -t aa-docker-socket-proxy:latest ./
72+
docker build -f ./Dockerfile -t nextcloud-appapi-dsp:latest ./
7373
```
7474

7575
Deploy image(for `nextcloud-docker-dev`):
7676

7777
```shell
7878
docker run -e NC_HAPROXY_PASSWORD="some_secure_password" \
7979
-v /var/run/docker.sock:/var/run/docker.sock \
80-
--name aa-docker-socket-proxy -h aa-docker-socket-proxy --net master_default \
81-
--privileged -d aa-docker-socket-proxy:latest
80+
--name nextcloud-appapi-dsp -h nextcloud-appapi-dsp --net master_default \
81+
--privileged -d nextcloud-appapi-dsp:latest
8282
```
8383

8484
After that create daemon in AppAPI from the Docker Socket Proxy template, specifying:
85-
1. Host: `aa-docker-socket-proxy:2375`
85+
1. Host: `nextcloud-appapi-dsp:2375`
8686
2. Network in Deploy Config equal to `master_default`
8787
3. Deploy Config: HaProxy password: `some_secure_password`
8888

8989
### HTTPS(remote)
9090

9191
We will emulate remote deployment still with `nextcloud-docker-dev` setup.
92-
For this we deploy `aa-docker-socket-proxy` to host network and reach it using `host.docker.internal`.
92+
For this we deploy `nextcloud-appapi-dsp` to host network and reach it using `host.docker.internal`.
9393

9494
> [!NOTE]
9595
> Due to current Docker limitations, this setup type is not working on macOS.
@@ -118,8 +118,8 @@ docker run -e NC_HAPROXY_PASSWORD="some_secure_password" \
118118
-e BIND_ADDRESS="172.17.0.1" \
119119
-v /var/run/docker.sock:/var/run/docker.sock \
120120
-v `pwd`/certs/cert.pem:/certs/cert.pem \
121-
--name aa-docker-socket-proxy -h aa-docker-socket-proxy --net host \
122-
--privileged -d aa-docker-socket-proxy:latest
121+
--name nextcloud-appapi-dsp -h nextcloud-appapi-dsp --net host \
122+
--privileged -d nextcloud-appapi-dsp:latest
123123
```
124124

125125
After that create daemon in AppAPI from the Docker Socket Proxy template, with next parameters:

tests/misc.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,23 +4,23 @@
44

55

66
def remove_haproxy():
7-
run("docker container rm aa-docker-socket-proxy --force".split(), stderr=DEVNULL, stdout=DEVNULL, check=False)
7+
run("docker container rm nextcloud-appapi-dsp --force".split(), stderr=DEVNULL, stdout=DEVNULL, check=False)
88

99

1010
def start_haproxy(port: int = 2375):
1111
tag = environ.get("TAG_SUFFIX", "latest")
1212
run(f"docker run -e NC_HAPROXY_PASSWORD='some_secure_password' -e HAPROXY_PORT={port} "
1313
"-v /var/run/docker.sock:/var/run/docker.sock "
14-
f"--name aa-docker-socket-proxy -h aa-docker-socket-proxy -p {port}:{port} "
15-
f"--rm --privileged -d aa-docker-socket-proxy:{tag}".split(),
14+
f"--name nextcloud-appapi-dsp -h nextcloud-appapi-dsp -p {port}:{port} "
15+
f"--rm --privileged -d nextcloud-appapi-dsp:{tag}".split(),
1616
stdout=DEVNULL,
1717
check=True)
1818

1919

2020
def wait_heartbeat():
2121
for i in range(60):
2222
r = run(
23-
["docker", "inspect", "--format='{{json .State.Health.Status}}'", "aa-docker-socket-proxy"],
23+
["docker", "inspect", "--format='{{json .State.Health.Status}}'", "nextcloud-appapi-dsp"],
2424
capture_output=True, check=True, )
2525
r = r.stdout.decode("UTF-8")
2626
if r.find("healthy") != -1:

0 commit comments

Comments
 (0)