AhmedTawfik/planka
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: Version 2

Browse Source 
Closes #627, closes #1047
This commit is contained in:
Maksim Eltyshev
2025-05-10 02:09:06 +02:00
parent ad7fb51cfa
commit 2ee1166747
1557 changed files with 76832 additions and 47042 deletions
Download Patch File Download Diff File Expand all files Collapse all files
charts/planka/README.md
+8 -8
View File
@@ -1,8 +1,8 @@
# Planka Helm Chart
# PLANKA Helm Chart
[Planka](https://github.com/plankanban/planka) is an OSS alternative to Trello that you can host yourself, and this is a Helm Chart to make it easier to deploy to K8s.
This Helm Chart simplifies the deployment of [PLANKA](https://github.com/plankanban/planka) on Kubernetes.
Shoutout to [this issue](https://github.com/plankanban/planka/issues/192) who have been asking for this Helm Chart.
Shoutout to [this issue](https://github.com/plankanban/planka/issues/192) for requesting a Helm Chart!
## Issues
@@ -32,9 +32,9 @@ helm install planka . --set secretkey=$SECRETKEY \
--set admin_username="demo"
```
> **NOTE:** The command `openssl rand -hex 64` is needed to create a random hexadecimal key for planka. On Windows you can use Git Bash to run that command.
> **Note:** The command `openssl rand -hex 64` is needed to create a random hexadecimal key for planka. On Windows you can use Git Bash to run that command.
To access Planka you can port forward using the following command:
To access PLANKA you can port forward using the following command:
```bash
kubectl port-forward $POD_NAME 3000:1337
@@ -42,7 +42,7 @@ kubectl port-forward $POD_NAME 3000:1337
### Accessing Externally
To access Planka externally you can use the following configuration
To access PLANKA externally you can use the following configuration
```bash
# HTTP only
@@ -70,7 +70,7 @@ or create a values.yaml file like:
```yaml
secretkey: "<InsertSecretKey>"
# The admin section needs to be present for new instances of Planka, after the first start you can remove the lines starting with admin_. If you want the admin user to be unchangeable admin_email: has to stay
# The admin section needs to be present for new instances of PLANKA, after the first start you can remove the lines starting with admin_. If you want the admin user to be unchangeable admin_email: has to stay
# After changing the config you have to run ```helm upgrade planka . -f values.yaml```
# Admin user
@@ -102,7 +102,7 @@ helm install planka . -f values.yaml
### Things to consider if production hosting
If you want to host Planka for more than just playing around with, you might want to do the following things:
If you want to host PLANKA for more than just playing around with, you might want to do the following things:
- Create a `values.yaml` with your config, as this will make applying upgrades much easier in the future.
- Create your `secretkey` once and store it either in a secure vault, or in your `values.yaml` file so it will be the same for upgrading in the future.