Skip to content

Commit

Permalink
update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
bbkz committed Jan 5, 2024
1 parent 6b230f7 commit 5aec7bf
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ Celery requires persistent volumes.
| `app.axes.failureLimit` | Limit of failed auth | String | `10` |
| `app.axes.cooloffTime` | in Minutes | String | `30` |
| `app.axes.ipwareProxyCount` | Count of proxies | String | `0` |
| `app.axes.ipwareMetaPrecedenceOrder` | Proxy header magnitude | List (comma separated string) | `"X_FORWARDED_FOR,REMOTE_ADDR"` |
| `app.axes.ipwareMetaPrecedenceOrder` | Proxy header magnitude | List (comma separated string) | `"HTTP_X_FORWARDED_FOR,REMOTE_ADDR"` |


### Nginx
Expand Down Expand Up @@ -185,7 +185,7 @@ Celery requires persistent volumes.

| Name | Description | Type | Default Value |
|------|-------------|------|---------------|
| `app.environment` | Array of objects, representing additional environment variables to set for the deployment. | Array | see [_helpers.yaml](charts/wger/templates/_helpers.yaml) and [values.yaml](charts/wger/values.yaml) |
| `app.environment` | Array of objects, representing additional environment variables to set for the deployment. | Array | see [_helpers.yaml](charts/wger/templates/_helpers.tpl) and [values.yaml](charts/wger/values.yaml) |

There are more possible ENV variables, than the ones used in the deployment. Please check [prod.env](https://github.com/wger-project/docker/blob/master/config/prod.env).

Expand Down Expand Up @@ -282,22 +282,28 @@ python3 manage.py axes_reset_ip [IP]
python3 manage.py axes_reset_username [USERNAME]
```

To temporary disable privacy mode to see the blocked ip in the log you can login to the container and add the following setting:

```bas
echo "AXES_SENSITIVE_PARAMETERS = []" >>settings.py
```


## Upgrading

wger is developped in a rolling release manner, so the docker image of the release is `:latest`, the hightest version tag `:X.x-dev` is the same as the `:latest` image. Older version tags are not changed or "bugfixed".

This means we cannot upgrade with changing the image tag.

As a consequence the default `values.yaml` has set `imagePullPolicy` to `Always`, this means on every restart of the pod the image will be downloaded.
As a consequence the default `values.yaml` has set `imagePullPolicy` to `Always`, this means if the kubelet has a container image with that exact digest cached locally, the kubelet uses its cached image; otherwise, the kubelet pulls the image with the resolved digest, and uses that image to launch the container.

To upgrade you can restart the deployment (k8s v1.15):

```bash
kubectl -n wger rollout restart deploy wger-app wger-celery wger-celery-worker
```

For PostgreSQL and Redis upgrades, please check the Groundhog2k documentation, linked at the end of the README.
For PostgreSQL and Redis upgrades, please check the Groundhog2k documentation, linked at the end.


### Postgres Upgrade Notes
Expand Down

0 comments on commit 5aec7bf

Please sign in to comment.