Skip to content

Commit daf9642

Browse files
henmohrhenmohr
committed
renomeia README
Signed-off-by: henmohr <henriquemohr@redes.ufsm.br>
1 parent d722fbf commit daf9642

File tree

3 files changed

+155
-155
lines changed

3 files changed

+155
-155
lines changed

‎README.en-US.md‎

Lines changed: 117 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
1+
# nextcloud-notify-push-docker
2+
3+
Docker packaging for `notify_push`, with the upstream source vendored in `./notify_push` via `git subtree`.
4+
5+
This repository adds:
6+
7+
- a Portuguese README for the vendored `notify_push` project
8+
- an example deployment behind `nginx-proxy`
9+
- GitHub Actions configuration to publish the image to GHCR
10+
11+
## Repository layout
12+
13+
- `notify_push/`: upstream `nextcloud/notify_push` source tree
14+
- `docker-compose.example.yml`: example deployment with `nginx-proxy`
15+
- `.github/workflows/publish-ghcr.yml`: image publishing workflow for GHCR
16+
17+
## Deploy behind nginx-proxy
18+
19+
Use the same host for Nextcloud and `notify_push`, and route `/push/` to the push service.
20+
21+
Example using the generic domain `cloud.example.com`:
22+
23+
```yaml
24+
services:
25+
nextcloud:
26+
image: nextcloud:apache
27+
environment:
28+
VIRTUAL_HOST: cloud.example.com
29+
VIRTUAL_PATH: /
30+
networks:
31+
- reverse-proxy
32+
- internal
33+
34+
notify_push:
35+
image: ghcr.io/librecodecoop/nextcloud-notify-push-docker:latest
36+
environment:
37+
PORT: "7867"
38+
NEXTCLOUD_URL: "https://cloud.example.com"
39+
REDIS_URL: "redis://redis:6379/0"
40+
DATABASE_URL: "postgres://nextcloud:secret@postgres/nextcloud"
41+
DATABASE_PREFIX: ""
42+
LOG: "info"
43+
VIRTUAL_HOST: cloud.example.com
44+
VIRTUAL_PATH: /push/
45+
VIRTUAL_DEST: /
46+
VIRTUAL_PORT: "7867"
47+
expose:
48+
- "7867"
49+
networks:
50+
- reverse-proxy
51+
- internal
52+
```
53+
54+
Important details:
55+
56+
- `notify_push` must be attached to the same Docker network as `nginx-proxy`
57+
- use `VIRTUAL_PATH=/push/` with the trailing slash
58+
- use `VIRTUAL_DEST=/` so the `/push/` prefix is stripped before forwarding the request
59+
- with `nginx-proxy`, `expose` is usually enough and you do not need to publish port `7867` on the host
60+
61+
## Configure in Nextcloud
62+
63+
Once the service is reachable through the reverse proxy:
64+
65+
```bash
66+
occ app:enable notify_push
67+
occ notify_push:setup https://cloud.example.com/push
68+
occ notify_push:self-test
69+
```
70+
71+
## Test the setup
72+
73+
Verify the proxy responses:
74+
75+
```bash
76+
curl -I https://cloud.example.com/push
77+
curl -I https://cloud.example.com/push/
78+
```
79+
80+
Expected behavior:
81+
82+
- `/push` returns `301` redirecting to `/push/`
83+
- `/push/` does not return `502` or another proxy upstream error
84+
85+
Watch the service logs while generating a Nextcloud notification, Talk message, or file change:
86+
87+
```bash
88+
docker compose logs -f notify_push
89+
```
90+
91+
## Publish to GHCR
92+
93+
The workflow in `.github/workflows/publish-ghcr.yml` builds the image from `notify_push/Dockerfile` and publishes it to
94+
GitHub Container Registry.
95+
96+
It runs on:
97+
98+
- pushes to `main`
99+
- version tags matching `v*`
100+
- manual dispatch
101+
102+
Required repository settings:
103+
104+
- GitHub Actions must be enabled
105+
- the workflow must have `packages: write` permission
106+
107+
The published image name is derived from the repository path, for example:
108+
109+
```text
110+
ghcr.io/librecodecoop/nextcloud-notify-push-docker:latest
111+
ghcr.io/librecodecoop/nextcloud-notify-push-docker:main
112+
```
113+
114+
## Portuguese docs
115+
116+
The Portuguese translation for the vendored upstream README is available at
117+
[`notify_push/README.pt-BR.md`](/home/mohr/git/librecode/nextcloud-notify-push-docker/notify_push/README.pt-BR.md).

‎README.md‎

Lines changed: 38 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
11
# nextcloud-notify-push-docker
22

3-
Docker packaging for `notify_push`, with the upstream source vendored in `./notify_push` via `git subtree`.
3+
Empacotamento Docker do `notify_push`, com o codigo-fonte upstream versionado em `./notify_push` via `git subtree`.
44

5-
This repository adds:
5+
Este repositorio adiciona:
66

7-
- a Portuguese README for the vendored `notify_push` project
8-
- an example deployment behind `nginx-proxy`
9-
- GitHub Actions configuration to publish the image to GHCR
7+
- um README em portugues para o projeto `notify_push` vendorizado
8+
- um exemplo de deploy atras do `nginx-proxy`
9+
- a configuracao de GitHub Actions para publicar a imagem no GHCR
1010

11-
## Repository layout
11+
## Estrutura do repositorio
1212

13-
- `notify_push/`: upstream `nextcloud/notify_push` source tree
14-
- `docker-compose.example.yml`: example deployment with `nginx-proxy`
15-
- `.github/workflows/publish-ghcr.yml`: image publishing workflow for GHCR
13+
- `notify_push/`: arvore de codigo do `nextcloud/notify_push`
14+
- `docker-compose.example.yml`: exemplo de deploy com `nginx-proxy`
15+
- `.github/workflows/publish-ghcr.yml`: workflow de publicacao da imagem no GHCR
1616

17-
## Deploy behind nginx-proxy
17+
## Deploy atras do nginx-proxy
1818

19-
Use the same host for Nextcloud and `notify_push`, and route `/push/` to the push service.
19+
Use o mesmo host para o Nextcloud e para o `notify_push`, roteando `/push/` para o servico de push.
2020

21-
Example using the generic domain `cloud.example.com`:
21+
Exemplo usando o dominio generico `cloud.example.com`:
2222

2323
```yaml
2424
services:
@@ -51,67 +51,68 @@ services:
5151
- internal
5252
```
5353
54-
Important details:
54+
Pontos importantes:
5555
56-
- `notify_push` must be attached to the same Docker network as `nginx-proxy`
57-
- use `VIRTUAL_PATH=/push/` with the trailing slash
58-
- use `VIRTUAL_DEST=/` so the `/push/` prefix is stripped before forwarding the request
59-
- with `nginx-proxy`, `expose` is usually enough and you do not need to publish port `7867` on the host
56+
- o `notify_push` precisa estar na mesma rede Docker do `nginx-proxy`
57+
- use `VIRTUAL_PATH=/push/` com barra final
58+
- use `VIRTUAL_DEST=/` para remover o prefixo `/push/` antes de encaminhar a requisicao
59+
- em setups com `nginx-proxy`, normalmente `expose` e suficiente e voce nao precisa publicar a porta `7867` no host
6060

61-
## Configure in Nextcloud
61+
## Configuracao no Nextcloud
6262

63-
Once the service is reachable through the reverse proxy:
63+
Depois que o servico estiver acessivel pelo proxy reverso:
6464

6565
```bash
6666
occ app:enable notify_push
6767
occ notify_push:setup https://cloud.example.com/push
6868
occ notify_push:self-test
6969
```
7070

71-
## Test the setup
71+
## Como testar
7272

73-
Verify the proxy responses:
73+
Valide as respostas do proxy:
7474

7575
```bash
7676
curl -I https://cloud.example.com/push
7777
curl -I https://cloud.example.com/push/
7878
```
7979

80-
Expected behavior:
80+
O comportamento esperado e:
8181

82-
- `/push` returns `301` redirecting to `/push/`
83-
- `/push/` does not return `502` or another proxy upstream error
82+
- `/push` responder com `301` para `/push/`
83+
- `/push/` nao responder com `502` ou outro erro de upstream do proxy
8484

85-
Watch the service logs while generating a Nextcloud notification, Talk message, or file change:
85+
Enquanto isso, acompanhe os logs do servico e gere um evento no Nextcloud, como uma notificacao, mensagem no Talk ou
86+
alteracao de arquivo:
8687

8788
```bash
8889
docker compose logs -f notify_push
8990
```
9091

91-
## Publish to GHCR
92+
## Publicacao no GHCR
9293

93-
The workflow in `.github/workflows/publish-ghcr.yml` builds the image from `notify_push/Dockerfile` and publishes it to
94+
O workflow em `.github/workflows/publish-ghcr.yml` constroi a imagem a partir de `notify_push/Dockerfile` e publica no
9495
GitHub Container Registry.
9596

96-
It runs on:
97+
Ele executa em:
9798

98-
- pushes to `main`
99-
- version tags matching `v*`
100-
- manual dispatch
99+
- pushes para `main`
100+
- tags de versao no formato `v*`
101+
- disparo manual
101102

102-
Required repository settings:
103+
Requisitos do repositorio:
103104

104-
- GitHub Actions must be enabled
105-
- the workflow must have `packages: write` permission
105+
- GitHub Actions habilitado
106+
- permissao `packages: write` para o workflow
106107

107-
The published image name is derived from the repository path, for example:
108+
O nome final da imagem e derivado do caminho do repositorio, por exemplo:
108109

109110
```text
110111
ghcr.io/librecodecoop/nextcloud-notify-push-docker:latest
111112
ghcr.io/librecodecoop/nextcloud-notify-push-docker:main
112113
```
113114

114-
## Portuguese docs
115+
## Documentacao em portugues do upstream
115116

116-
The Portuguese translation for the vendored upstream README is available at
117+
O README em portugues do projeto vendorizado esta em
117118
[`notify_push/README.pt-BR.md`](/home/mohr/git/librecode/nextcloud-notify-push-docker/notify_push/README.pt-BR.md).

‎README.pt-BR.md‎

Lines changed: 0 additions & 118 deletions
This file was deleted.

0 commit comments

Comments
 (0)