diff --git a/README.md b/README.md index 5c5baa01f6e2ce53024be599c48fef7881de5f6b..bb563fec00099a6800c5f8170f4d6b96bdbe0a07 100644 --- a/README.md +++ b/README.md @@ -2,12 +2,13 @@ This repository extends [Stackspin](https://open.greenhost.net/stackspin/stackspin) with extra applications and overrides -to make it more commercially/professionally interesting. +focused on business use. Once stabilized, the aim is to contribute as much upstream as possible. Stackspout is used in day-to-day business with a double-digit user number, so all experiments happen carefully. +Still, it is an experimental offering. ## Tools @@ -17,8 +18,8 @@ Useful tools for administration: - stackspin docs: https://docs.stackspin.net/en/v2/system_administration/customizing.html -### Guide: Create OAuth Credentials for an external service -- add a line in `basic/install.sh` and run it to generate the secret +### Guide: Creating OAuth Credentials for an external service +- add a line in `basic/install.sh` and run it to generate the secret (TODO: Update to new stackspin mechanism) - append another OAuth2Client definition to `basic/overrides/oauth-clients.yaml`, adjusting `metadata.name` and `spec.secretName` as well as `spec.redirectUris` - apply changes to the cluster @@ -34,15 +35,17 @@ Useful tools for administration: ### Overrides - Adds many Nextcloud extensions and some configuration -- Add Email Auth back to Zulip + -> most notably `external` to add Applications into Nextcloud as hub +- Add Email Auth back to Zulip so guests can be invited ### New Applications below list is formatted as: > subdomain: Service (helmrepo, if not provided by the service authors) + #### Stable including Single-Sign-On -- dev: Gitea -- do: Vikunja (k8s-at-home - migrating to truecharts) -- ninja: InvoiceNinja +- dev: Gitea (TODO: Forgej) +- do: Vikunja (k8s-at-home - migrating to creators chart) +- ninja: InvoiceNinja (No SSO) #### In Development - people: SuiteCRM (bitnami repo) - time: Kimai (robjuz repo) @@ -51,26 +54,30 @@ below list is formatted as: - wiki: Wiki (maybe wikijs, but I'd like something that integrated with Nextcloud and Markdown/Orgdown) #### Ideas - link: URL Shortener -- Bonfire +- connect: Bonfire -### Issues to tackle -#### Structurally +### Issues to Tackle - generate_secrets.py was copied from Stackpin + -> new mechanism #### Functionally -- Nextcloud too slow - add Redis +- Nextcloud too slow - add Redis? - Preconfigure user settings in Nextcloud, Vikunja and more -## Installation +## Setup > Warning: Lots of experiments happening here! -Apply it to your cluster: +First [install Stackspin](https://docs.stackspin.net/en/latest/installation/install_stackspin.html). +Then apply the configuration to your cluster: ```sh basic/install.sh ``` -List the resource related to this repo: +Done! +Note that the added applications are currently only toggled via repository changes +and integration with Stackspin mechanisms is very rudimentary. +To list the central resource related to this repo: ```sh kubectl get gitrepositories -A @@ -79,4 +86,4 @@ kubectl -n stackspout get helmreleases kubectl -n stackspout get pods ``` -But there are also ConfigMaps, Secrets, StatefulSets, PVCs, Helmrepos and all that stuff... +But there are also ConfigMaps, Secrets, StatefulSets, PVCs, Helmrepos and more... diff --git a/basic/install.sh b/basic/install.sh index 6d19eb424414159efc8c72df95ca8804f187b105..047afdc83b91fa2ea93a33626632e9b43a82ade1 100755 --- a/basic/install.sh +++ b/basic/install.sh @@ -19,7 +19,3 @@ python $(dirname "$0")/../generate_secrets.py vikunja python $(dirname "$0")/../generate_secrets.py vikunja-test python $(dirname "$0")/../generate_secrets.py gitea python $(dirname "$0")/../generate_secrets.py invoiceninja -#python $(dirname "$0")/../generate_secrets.py suitecrm -#python $(dirname "$0")/../generate_secrets.py kimai -python $(dirname "$0")/../generate_secrets.py wikijs -python $(dirname "$0")/../generate_secrets.py nextcloud-home