Page MenuHomePhorge

No OneTemporary

Authored By
Unknown
Size
8 KB
Referenced Files
None
Subscribers
None
diff --git a/docs/docs/administration/usermanagement.md b/docs/docs/administration/usermanagement.md
new file mode 100644
index 0000000..f61f581
--- /dev/null
+++ b/docs/docs/administration/usermanagement.md
@@ -0,0 +1,17 @@
+# Usermanagement
+
+## Reset a user password
+
+To reset a user password from the command line:
+
+```
+kubectl exec -ti deployments/horizon -- ./artisan user:password $USER $PASSWORD
+```
+
+### Remove 2fa
+
+Remove and reset 2fa for a user by removing the 2fa sku:
+
+```
+kubectl exec -ti deployments/horizon -- ./artisan user:remove-sku $USER 2fa
+```
diff --git a/docs/docs/overview/about.md b/docs/docs/home/about/index.md
similarity index 80%
rename from docs/docs/overview/about.md
rename to docs/docs/home/about/index.md
index 87278fe..46c5fca 100644
--- a/docs/docs/overview/about.md
+++ b/docs/docs/home/about/index.md
@@ -1,81 +1,66 @@
-
-
# What is Kolab?
Kolab integrates multiple components to provide you with a fully-fledged communication and collaboration solution.
This includes:
* Being able to send & receive email including:
* spam filtering
* virus scanning
* Support for important protocols that ensure secure email delivery (DKIM/DMARC/SPF)
* A variety of access protocols:
* IMAP/SMTP
* ActiveSync
* CalDAV/CardDAV
* A webmail client that includes advanced calendaring/tasks/addressbook
* A webrtc based video chat solution
* File storage
* Collaborative editing of documents
In short, it provides everything that a company/family/... needs to work and communicate together, while maintaining full control over all data.
-# Kolab 3 vs Kolab 4
-
-Kolab has undergone a major revision from generation 3 to generation 4.
-
-The following is a short list of major changes:
-
-* Kolab is now at it's core a PHP application in laravel, which integrates all services via an API.
-* Historically, groupware data has been stored in XML messages in IMAP (so called Kolab Objects). This is no longer the case. Kolab now uses Cyrus provided DAV for Calendar/Tasks/Contacts and the Kolab Files API for files.
-* Packages are no longer the primary distribution mechanism with a switch to conatinerized deployments.
-* LDAP is no longer used by Kolab.
-* The Webadmin panel has been replaced by Kolab Cockpit.
-* pykolab/kolabd/wallace functionality has been integrated into the central Kolab API.
-
# What is Kolab on Kubernetes?
Kolab on Kubernetes is a complete Kolab distribution that includes everything you need to run Kolab in production.
Kolab consists of many components that work together. All these components can be configured separately, with a great deal of flexibility.
Kolab on Kubernetes packages all components via container images and a Helm chart, into a turnkey solution that brings everything required with it.
This includes Kolab, but also everything that you require to run Kolab:
* All required services such as:
* IMAP/CalDAV/CardDAV server (Cyrus)
* SQL database server (MariaDB)
* Cache server (Redis)
* SMTP server (Postfix)
* Spam/Virus checker (Amavis)
* HTTP server (Apache)
* HTTP server/Proxy (NGINX)
* A log aggregation solution based on Vector and Loki
* A monitoring and alerting solution based on Loki/Prometheus and Alertmanager
* An optional integrated Matrix service
* Integrated collaborative editing (Collabora)
* A WebRTC video-conferencing solution (Kolab Meet)
By integrating all services into a Kubernetes deployment it is ensured that the entire solution can be tested and deployed, in the exact same configuration,
as many times as desired.
Further benefits:
* The system is described by the values.yaml along with the used images in its entirety. No more manual modifications that nobody knows about or blind spots that are not covered by ansible. If it's not reproducible, it's not available.
* Configurations that affect multiple components can be centrally managed, and the Helm chart takes care that all required configuration changes happen.
* Kolab on Kubernetes is ideal for a GitOps approach where all changes to the system are tracked in a version control system.
* Kolab on Kubernetes can be used for small single host deployments with k3s or large clustered deployments on Openshift.
* It is possible to integrate existing infrastructure, such as an existing MariaDB cluster, which can make sense if the same infrastructure is already used elsewhere.
## Who is this for
Kolab on Kubernetes is the recommended way to run Kolab.
It provides not only the software, but also a defined and recommended overall architecture.
## Who is this not for
Kolab itself is very flexible, and if that flexibility is used in an existing setup to it's full extent, it's possible that the same configuration is currently not supported by Kolab on Kubernetes.
diff --git a/docs/docs/home/about/kolab3.md b/docs/docs/home/about/kolab3.md
new file mode 100644
index 0000000..a708e87
--- /dev/null
+++ b/docs/docs/home/about/kolab3.md
@@ -0,0 +1,13 @@
+# Kolab 3 vs Kolab 4
+
+Kolab has undergone a major revision from generation 3 to generation 4.
+
+The following is a short list of major changes:
+
+* Kolab is now at it's core a PHP application in laravel, which integrates all services via an API.
+* Historically, groupware data has been stored in XML messages in IMAP (so called Kolab Objects). This is no longer the case. Kolab now uses Cyrus provided DAV for Calendar/Tasks/Contacts and the Kolab Files API for files.
+* Packages are no longer the primary distribution mechanism with a switch to conatinerized deployments.
+* LDAP is no longer used by Kolab.
+* The Webadmin panel has been replaced by Kolab Cockpit.
+* pykolab/kolabd/wallace functionality has been integrated into the central Kolab API.
+
diff --git a/docs/docs/home/contribute.md b/docs/docs/home/contribute.md
new file mode 100644
index 0000000..3f1acc7
--- /dev/null
+++ b/docs/docs/home/contribute.md
@@ -0,0 +1,19 @@
+# Contribute
+
+We use <git.kolab.org> for development, which is a [phorge](https://we.phorge.it/) instance.
+
+Please note that new accounts will have to be manually approved after creating,
+because of spam signups. Please send an email to <contact@apheleia-it.ch> to get your account approved.
+
+## Creating a patch
+
+Instead of pull requests reviews are handled in the form off diffs.
+
+You may create a diff here: <https://git.kolab.org/differential/diff/create/>
+
+If this is just a single patch you may want to upload the diff directly,
+the recommended workflow is to setup [arc](https://we.phorge.it/diviner/find/?name=Arcanist%20User%20Guide&type=article&jump=1) otherwise.
+
+## Mailing lists
+
+Our mailing lists are here: <https://lists.kolab.org/mailman/listinfo>
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
index 830a02c..fe37d6c 100644
--- a/docs/mkdocs.yml
+++ b/docs/mkdocs.yml
@@ -1,51 +1,55 @@
---
site_name: Kolab Documentation 4.0.16
site_url: https://docs.kolab.org/
repo_name: kolab-infrastructure
repo_url: https://git.kolab.org/source/kolab-infrastructure
theme:
name: material
palette:
primary: grey
accent: custom
font:
text: Nunito
logo: assets/mail-blue.png
favicon: assets/mail-blue.png
features:
- navigation.sections
- navigation.instant
- navigation.tabs
- navigation.top
- navigation.tracking
- navigation.indexes
- search.highlight
- search.share
- search.suggest
- toc.follow
plugins:
- privacy
extra_css:
- stylesheets/extra.css
markdown_extensions:
- admonition
- pymdownx.details
- pymdownx.superfences
nav:
- - Home: index.md
- - Overview:
- - About: overview/about.md
+ - Home:
+ - index.md
+ - About:
+ - home/about/index.md
+ - home/about/kolab3.md
+ - Contribute: home/contribute.md
- Deploy:
- deploy/index.md
- Quickstart: deploy/quickstart.md
- Supported Platforms: deploy/supported-platforms.md
- About Kolab on Kubernetes: deploy/about-kolab-on-kubernetes.md
- Reference Architectures:
- deploy/reference-architectures/index.md
- Single Node K3s: deploy/reference-architectures/single-node-k3s.md
- Replicated K3s: deploy/reference-architectures/replicated-k3s.md
- Kubernetes Cluster: deploy/reference-architectures/kubernetes-cluster.md
- Networking: deploy/networking.md
- Administration:
- Notes: administration/notes.md
- Migration: administration/migration.md
+ - User management: administration/usermanagement.md

File Metadata

Mime Type
text/x-diff
Expires
Sat, Apr 4, 9:50 AM (3 w, 5 d ago)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
18823547
Default Alt Text
(8 KB)

Event Timeline