diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 0000000..eeed778 --- /dev/null +++ b/.gitmodules @@ -0,0 +1,3 @@ +[submodule "docs/tools"] + path = docs/tools + url = https://git.local-it.org/local-it/tools diff --git a/docs/apps/matrix.md b/docs/apps/matrix.md deleted file mode 100644 index b2aadfa..0000000 --- a/docs/apps/matrix.md +++ /dev/null @@ -1,31 +0,0 @@ -# Matrix - -### deployment - -``` -abra app new matrix-synapse -abra app config matrix.example.org -abra app deploy matrix.example.org -abra app new element-web -abra app config chat.example.org -abra app deploy chat.example.org -``` - - -## Migration - - -### Backup - - -### Restore - -secrets importieren -signing-key kopieren -media-store kopien /data/media_store -db dump importieren - -check that user 991 has ownership of /data/media_store - - - diff --git a/docs/extra.css b/docs/extra.css new file mode 100644 index 0000000..aee7ad3 --- /dev/null +++ b/docs/extra.css @@ -0,0 +1,8 @@ +h1 { +} + + +.md-header { + background-color: #f5bd1c + +} \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 44b3689..e6b4980 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,14 +1,24 @@ -# Software für kollaboratives Arbeiten [SKA] +# Local-IT e.V. -[Installation](installation.md) +## Tool Übersicht -## Apps +[Liste mit kollaborativen Tools](tools/README.md) -* [Authentik](apps/authentik.md) -* [Nextcloud](apps/nextcloud.md) -* [OnlyOffice](apps/onlyoffice.md) -* [Wekan](apps/wekan.md) +## Software für kollaboratives Arbeiten [SKA] + + + +### Installation + +[Installation](installation/) + +Apps: + +* [Authentik](installation/authentik.md) +* [Nextcloud](installation/nextcloud.md) +* [OnlyOffice](installation/onlyoffice.md) +* [Wekan](installation/wekan.md) --- diff --git a/docs/apps/authentik.md b/docs/installation/authentik.md similarity index 85% rename from docs/apps/authentik.md rename to docs/installation/authentik.md index 9cc7366..5b68e18 100644 --- a/docs/apps/authentik.md +++ b/docs/installation/authentik.md @@ -1,3 +1,7 @@ +--- +title: Single-Sign-On Provider +--- + # Single-Sign-On Provider [Authentik](https://goauthentik.io) ist unser Single-Sign-On (SSO) Provider und Identity Management. diff --git a/docs/apps/bigbluebutton.md b/docs/installation/bigbluebutton.md similarity index 100% rename from docs/apps/bigbluebutton.md rename to docs/installation/bigbluebutton.md diff --git a/docs/apps/foodsoft.md b/docs/installation/foodsoft.md similarity index 100% rename from docs/apps/foodsoft.md rename to docs/installation/foodsoft.md diff --git a/docs/apps/gitea.md b/docs/installation/gitea.md similarity index 100% rename from docs/apps/gitea.md rename to docs/installation/gitea.md diff --git a/docs/apps/hedgedoc.md b/docs/installation/hedgedoc.md similarity index 100% rename from docs/apps/hedgedoc.md rename to docs/installation/hedgedoc.md diff --git a/docs/installation.md b/docs/installation/index.md similarity index 98% rename from docs/installation.md rename to docs/installation/index.md index 277909f..4775f74 100644 --- a/docs/installation.md +++ b/docs/installation/index.md @@ -1,3 +1,7 @@ +--- +title: Installation +--- + # Installation Unser Setup basiert auf [abra](https://git.coopcloud.tech/coop-cloud/abra) von [coopcloud](https://coopcloud.tech) diff --git a/docs/apps/keycloak.md b/docs/installation/keycloak.md similarity index 100% rename from docs/apps/keycloak.md rename to docs/installation/keycloak.md diff --git a/docs/installation/kimai.md b/docs/installation/kimai.md new file mode 100644 index 0000000..fe89830 --- /dev/null +++ b/docs/installation/kimai.md @@ -0,0 +1,11 @@ +### sso + +saml +https://www.kimai.org/documentation/saml-authentik.html +* mapper für name: SAML Property Mapping + name: name + saml-attribute: $http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name + ausdruck: return user.username + + +https://goauthentik.io/integrations/services/kimai/ \ No newline at end of file diff --git a/docs/installation/matrix.md b/docs/installation/matrix.md new file mode 100644 index 0000000..338cf6e --- /dev/null +++ b/docs/installation/matrix.md @@ -0,0 +1,46 @@ +# Matrix + +### deployment + +``` +abra app new matrix-synapse +abra app config matrix.example.org +abra app deploy matrix.example.org +abra app new element-web +abra app config chat.example.org +abra app deploy chat.example.org +``` + + +## Migration + + +### Backup + + +### Restore + +secrets importieren +signing-key kopieren +media-store kopien /data/media_store +db dump importieren + +check that user 991 has ownership of /data/media_store + + + + + + +-- + + +https://www.matrix.org/docs/api/#overview + +https://www.matrix.org/docs/guides/client-server-api + + +curl -X POST -d '{"type":"m.login.password", "user":"admin", "password":""}' http://localhost:8008/_matrix/client/r0/login +{"user_id":"@admin:matrix.local-it.org","access_token":"syt_YWRtaW4_nNAvEJZqiMqOCOqizuIQ_1oR29V","home_server":"matrix.local-it.org","device_id":"YSZDLGKMQI","well_known":{"m.homeserver":{"base_url":"https://matrix.local-it.org/"}}} + +curl --header "Authorization: Bearer secretsecret" -X POST -d '{"user_id": "@yksflip:matrix.kaputt.cloud"}' http://localhost:8008/_synapse/admin/v1/rooms/\!TvsvJVDwEFtMnPCbkA:matrix.local-it.org/make_room_admin \ No newline at end of file diff --git a/docs/apps/nextcloud.md b/docs/installation/nextcloud.md similarity index 100% rename from docs/apps/nextcloud.md rename to docs/installation/nextcloud.md diff --git a/docs/apps/onlyoffice.md b/docs/installation/onlyoffice.md similarity index 100% rename from docs/apps/onlyoffice.md rename to docs/installation/onlyoffice.md diff --git a/docs/apps/wekan.md b/docs/installation/wekan.md similarity index 100% rename from docs/apps/wekan.md rename to docs/installation/wekan.md diff --git a/docs/installation/zammad.md b/docs/installation/zammad.md new file mode 100644 index 0000000..b36da0e --- /dev/null +++ b/docs/installation/zammad.md @@ -0,0 +1,22 @@ + +## sso + +saml +https://admin-docs.zammad.org/en/latest/settings/security/third-party/saml.html + + +Einstellungen -> Sicherheit -> Anwendungen von Drittanbietern + +https://sso.local-it.org/application/saml/zammad/sso/binding/init +https://goauthentik.io/docs/providers/saml +idp-initated-login + + +customization -> Property Mappings -> Create SAML +mappings: +https://goauthentik.io/docs/property-mappings/expression +https://goauthentik.io/docs/user-group/user#object-attributes + +Danach dem Provider die neuen Mappings hinzufügen + + diff --git a/docs/scratch/howtowintegrateaapp.drawio b/docs/scratch/howtowintegrateaapp.drawio new file mode 100644 index 0000000..1ccea16 --- /dev/null +++ b/docs/scratch/howtowintegrateaapp.drawio @@ -0,0 +1,80 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/tools b/docs/tools new file mode 160000 index 0000000..b3f7eae --- /dev/null +++ b/docs/tools @@ -0,0 +1 @@ +Subproject commit b3f7eae1f7c1fb9e9eb54288d4a8471842f99f71 diff --git a/mkdocs.yml b/mkdocs.yml index 7532007..90107de 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,4 +1,4 @@ -site_name: LIT Docs +site_name: local-it Dokumentation site_url: https://docs.local-it.org theme: @@ -15,5 +15,23 @@ markdown_extensions: - pymdownx.superfences repo_name: LIT/docs -repo_url: https://git.local-it.org/LIT/docs +repo_url: https://git.local-it.org/local-it/docs edit_uri: _edit/main/docs/ + +nav: + - Home: index.md + - Toolübersicht: tools/README.md + - Installation: + - Basis: installation/ + - Single-Sign-On Provider: installation/authentik/ + - Tools: + - Nextcloud: installation/nextcloud/ + - Wekan: installation/wekan/ + - FAQ: faq.md + - Source Code (Gitea): https://git.local-it.org + - Rechtliches: + - Datenschutz: https://local-it.org/datenschutzerklaerung/ + - Impressum: https://local-it.org/datenschutzerklaerung/ + +extra_css: + - extra.css \ No newline at end of file