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
22 changes: 22 additions & 0 deletions docs/howtos/contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,28 @@ If not, the Developer Certificate of Origin (DCO) check rejects the pull request

:::

## Development Environment

For detailed instructions on setting up a local development environment, please refer to the [Development Guidelines](https://github.com/epinio/epinio/blob/main/docs/howtos/development.md) in the Epinio repository.

### Updating the running Epinio server

Every time a change is made in the Epinio source code, the binary running inside
the epinio-server Pod has to be replaced with a freshly compiled one. This can
be achieved by running the following command:

```bash
make && make patch-epinio-deployment
```

If Epinio is installed in a custom namespace, you need to specify it using the `EPINIO_NAMESPACE` environment variable:

```bash
EPINIO_NAMESPACE=my-namespace make && EPINIO_NAMESPACE=my-namespace make patch-epinio-deployment
```

This first compiles a new binary locally and then replaces the one running inside the Pod with it.

## Pull requests

Pull requests for a code change should reference the issue they're for.
Expand Down
12 changes: 12 additions & 0 deletions docs/installation/install_epinio.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,18 @@ helm repo update
helm upgrade --install epinio epinio/epinio --namespace epinio --create-namespace \
--set global.domain=myepiniodomain.org
```

### Install Epinio in a custom namespace

You can install Epinio in a custom namespace by changing the `--namespace` flag.

```bash
helm repo add epinio https://epinio.github.io/helm-charts
helm repo update
helm upgrade --install epinio epinio/epinio --namespace my-custom-namespace --create-namespace \
--set global.domain=myepiniodomain.org
```

Or you can install using "Let's Encrypt" certificates.

To generate trusted TLS certificates with "Let's Encrypt" for your public domain set `.Values.global.tlsIssuer` to `letsencrypt-production` and the value for the `.Values.global.tlsIssuerEmail` key to your e-mail address. Then:
Expand Down
6 changes: 6 additions & 0 deletions docs/installation/uninstall_epinio.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,9 @@ If you installed Epinio in a namespace `epinio`, you uninstall with the command:
```bash
$ helm uninstall -n epinio epinio
```

If you installed Epinio in a custom namespace, replace `epinio` with your custom namespace:

```bash
$ helm uninstall -n <custom-namespace> epinio
```