diff --git a/modules/ROOT/pages/index.adoc b/modules/ROOT/pages/index.adoc index c90d9a7e8..804a89dad 100644 --- a/modules/ROOT/pages/index.adoc +++ b/modules/ROOT/pages/index.adoc @@ -1,76 +1,15 @@ -= Introduction to Infinite Scale += The Infinite Scale Documentation :toc: right :toclevels: 2 -:description: Welcome to the Infinite Scale documentation. Infinite Scale is a data platform providing tools to integrate, organize, share and govern data and metadata. This guide provides information on general topics, on installation and administrative tasks for Infinite Scale. +:description: Welcome to the Infinite Scale documentation. Infinite Scale is a data platform providing tools to integrate, organize, share and govern data and metadata. -:github-url: https://github.com/owncloud/docs-ocis/issues - -:ocis_youtube_long_url: https://www.youtube.com/watch?v=C4a4q9IGyFQ&list=PLXpTv1ixYy3-b5LScHyYqMNwEsZYgejdX&index=16 -:ocis_youtube_short_url: C4a4q9IGyFQ - -include::partial$multi-location/compose-version.adoc[] +include::admin:partial$multi-location/compose-version.adoc[] == Introduction {description} -// IMPORTANT: this permalink origins to: https://cloud.owncloud.com/index.php/apps/files/?dir=/Shared/owncloud/Product%20Management/Presentations/2023-05-22_Infinite%20Scale%20current%20state&fileid=6005441 - -=== Target Audience - -This documentation addresses administrators and technically-oriented management: - -* people responsible that services are up and running for users, -* people responsible that the IT infrastructure is in line with the organization's compliance regulations, -* technical advisors and technical buyers. - -=== Infinite Scale Key Benefits - -The Infinite Scale data platform is designed for multi-storage access, is cloud-native (microservices) and provides unified data access. - -The key benefits are:: - -* Integration of distributed data sources into one cloud data ecosystem. -* A unified data access layer across all data. -* Combination of on-premises and cloud-operated environments into one user experience. -* No need for PHP or a database. -* High performance, flexibility and scalability. -* Extended functionality. -* Container delivery, shipped with the user interface `ownCloud Web`. - -See the following in-line YouTube video for more details or use the link:{ocis_youtube_long_url}[link, window=_blank] to view it in a separate browser tab. - -.Infinite Scale - A new era for ownCloud - ownCloud Conference 2021 -video::{ocis_youtube_short_url}[youtube] - -// fixme: we should have a cross-component link to ownCloud Web when available -// fixme: shall we have a feature list page ? - -== Brief Overview - -NOTE: In configuration variables and comments, you'll often come across the word oCIS or ocis, short for "ownCloud Infinite Scale", while the product is simply called Infinite Scale. - -=== Architecture and Concepts - -To learn more about Infinite Scale, check out the xref:architecture/architecture.adoc[Architecture and Concepts] section first. This information may help deciding which environment is optimal for your use case and which hardware fits your needs best. - -=== Availability and Scalability - -With knowledge about architecture and concepts, look at the different xref:availability_scaling/availability_scaling.adoc[Availability and Scalability] options to define the environment Infinite Scale should run on. - -=== Prerequisites - -With Infinite Scale, not much is needed to run your ownCloud server the way you want. Check out the details in the xref:prerequisites/prerequisites.adoc[Prerequisites] section. We strongly recommend to make up your mind about availability and scalability first. - -=== Deployment - -Infinite Scale is deployed via container. Take a look at the Deployment Examples section in the navigation for more details. - -NOTE: We highly recommend reading the xref:deployment/general/general-info.adoc[General Info] document first before starting to plan or deploy Infinite Scale. This document contains important topics relevant for all deployments. - -=== Configuration Examples - -Configuration of Infinite Scale might be quite different to what you are used to but it's very simple. It works with environment variables and optional configuration files for you to create depending on your specific needs. The settings in configuration files can always be overruled by setting the respective environment variables manually on the command line. +This documentation provides xref:admin:index.adoc[admin] and xref:developer:index.adoc[developer] related information. == Release Life Cycle diff --git a/modules/ROOT/partials/nav.adoc b/modules/ROOT/partials/nav.adoc index 393febb94..8f0a8fdb2 100644 --- a/modules/ROOT/partials/nav.adoc +++ b/modules/ROOT/partials/nav.adoc @@ -1,105 +1,4 @@ * xref:index.adoc[Introduction] -* Infinite Scale Overview -** xref:architecture/architecture.adoc[Architecture and Concepts] -** xref:availability_scaling/availability_scaling.adoc[Availability and Scalability] -** xref:security/security.adoc[Security Aspects] -* xref:deployment/index.adoc[Deployment] -** xref:prerequisites/prerequisites.adoc[Prerequisites] -** Storage -*** xref:deployment/storage/general-considerations.adoc[General Storage Considerations] -*** xref:deployment/storage/nfs.adoc[Network File System] -*** xref:deployment/storage/s3.adoc[S3] -*** xref:deployment/storage/posixfs.adoc[PosixFS] -** xref:deployment/general/general-info.adoc[General Information] -** xref:deployment/general/ocis-init.adoc[The ocis init Command] -** xref:deployment/wopi/wopi.adoc[Office Applications using WOPI] -** xref:deployment/security/security.adoc[Securing oCIS] -** xref:deployment/gdpr/gdpr.adoc[User Triggered GDPR Report] -** xref:deployment/services/services.adoc[Services] -*** General Information -**** xref:deployment/services/deployment-considerations.adoc[Deployment Considerations] -**** xref:deployment/services/env-var-note.adoc[Environment Variable Notes] -**** xref:deployment/services/env-vars-special-scope.adoc[Environment Variables with Special Scope] -**** xref:deployment/services/env-var-changes.adoc[Environment Variable Changes] -**** xref:deployment/services/registry.adoc[Registry] -**** xref:deployment/services/caching.adoc[Caching and Persistence] -**** xref:deployment/services/gateways.adoc[Gateways] -**** xref:deployment/services/logging.adoc[Logging] -**** xref:deployment/services/ports-used.adoc[Ports Used] -**** xref:deployment/services/tls.adoc[Transport Layer Security] -*** List of Services -**** xref:deployment/services/s-list/activitylog.adoc[Activitylog] -**** xref:deployment/services/s-list/antivirus.adoc[Antivirus] -**** xref:deployment/services/s-list/app-provider.adoc[App Provider] -**** xref:deployment/services/s-list/app-registry.adoc[App Registry] -**** xref:deployment/services/s-list/audit.adoc[Audit] -**** xref:deployment/services/s-list/auth-app.adoc[Auth App] -**** xref:deployment/services/s-list/auth-basic.adoc[Auth Basic] -**** xref:deployment/services/s-list/auth-bearer.adoc[Auth Bearer] -**** xref:deployment/services/s-list/auth-machine.adoc[Auth Machine] -**** xref:deployment/services/s-list/auth-service.adoc[Auth Service] -**** xref:deployment/services/s-list/clientlog.adoc[Clientlog] -**** xref:deployment/services/s-list/collaboration.adoc[Collaboration] -**** xref:deployment/services/s-list/eventhistory.adoc[Eventhistory] -**** xref:deployment/services/s-list/frontend.adoc[Frontend] -**** xref:deployment/services/s-list/gateway.adoc[Gateway] -**** xref:deployment/services/s-list/graph.adoc[Graph] -**** xref:deployment/services/s-list/groups.adoc[Groups] -**** xref:deployment/services/s-list/idm.adoc[IDM] -**** xref:deployment/services/s-list/invitations.adoc[Invitations] -**** xref:deployment/services/s-list/idp.adoc[IDP] -**** xref:deployment/services/s-list/nats.adoc[NATS] -**** xref:deployment/services/s-list/notifications.adoc[Notifications] -**** xref:deployment/services/s-list/ocdav.adoc[OCDAV] -**** xref:deployment/services/s-list/ocm.adoc[OCM] -**** xref:deployment/services/s-list/ocs.adoc[OCS] -**** xref:deployment/services/s-list/policies.adoc[Policies] -**** xref:deployment/services/s-list/postprocessing.adoc[Postprocessing] -**** xref:deployment/services/s-list/proxy.adoc[Proxy] -**** xref:deployment/services/s-list/search.adoc[Search] -**** xref:deployment/services/s-list/settings.adoc[Settings] -**** xref:deployment/services/s-list/sharing.adoc[Sharing] -**** xref:deployment/services/s-list/sse.adoc[SSE] -**** xref:deployment/services/s-list/store.adoc[Store] -**** xref:deployment/services/s-list/storage-publiclink.adoc[Storage-Publiclink] -**** xref:deployment/services/s-list/storage-shares.adoc[Storage-Shares] -**** xref:deployment/services/s-list/storage-system.adoc[Storage-System] -**** xref:deployment/services/s-list/storage-users.adoc[Storage-Users] -**** xref:deployment/services/s-list/thumbnails.adoc[Thumbnails] -**** xref:deployment/services/s-list/userlog.adoc[Userlog] -**** xref:deployment/services/s-list/users.adoc[Users] -**** xref:deployment/services/s-list/web.adoc[Web] -**** xref:deployment/services/s-list/webdav.adoc[WebDAV] -**** xref:deployment/services/s-list/webfinger.adoc[Webfinger] -** Web UI -*** xref:deployment/webui/webui-customisation.adoc[Custom Configuration] -*** xref:deployment/webui/webui-theming.adoc[Custom Theming] -* Maintenance -** Backup and Restore -*** xref:maintenance/b-r/backup_considerations.adoc[Backup Considerations] -*** xref:maintenance/b-r/backup.adoc[Backup] -*** xref:maintenance/b-r/restore.adoc[Restore] -** xref:maintenance/commands/commands.adoc[Maintenance Commands] -** xref:maintenance/m-mode/maintenance-mode.adoc[Maintenance Mode] -** xref:maintenance/space-ids/space-ids.adoc[Listing Space IDs] -** xref:maintenance/user-ids/user-ids.adoc[Listing User IDs] -* Migration and Upgrades -** xref:migration/upgrading-ocis.adoc[Upgrading Infinite Scale] -* Monitoring -** xref:monitoring/prometheus.adoc[Prometheus] -* Configuration Examples -** xref:conf-examples/office/office-integration.adoc[Office Integration] -** xref:conf-examples/search/configure-search.adoc[Search] -* Deployment Examples -** Ubuntu with Docker Compose -*** xref:depl-examples/ubuntu-compose/ubuntu-compose-prod.adoc[Local Production Setup] -*** xref:depl-examples/ubuntu-compose/ubuntu-compose-hetzner.adoc[Deployment on Hetzner] -** Setup Federations -*** xref:depl-examples/federation/sciencemesh.adoc[ScienceMesh Setup] -* Additional Information -** xref:additional-information/knowledge-base.adoc[Knowledge Base] +include::admin:partial$nav.adoc[] +// include::developer:partial$nav.adoc[] -//// -* Migration -** xref:migration/index.adoc[Migrating from ownCloud 10 to ownCloud Infinite Scale] -//// diff --git a/modules/ROOT/attachments/.gitkeep b/modules/admin/attachments/.gitkeep similarity index 100% rename from modules/ROOT/attachments/.gitkeep rename to modules/admin/attachments/.gitkeep diff --git a/modules/ROOT/attachments/architecture/infinite-scale-c4-model.dsl b/modules/admin/attachments/architecture/infinite-scale-c4-model.dsl similarity index 100% rename from modules/ROOT/attachments/architecture/infinite-scale-c4-model.dsl rename to modules/admin/attachments/architecture/infinite-scale-c4-model.dsl diff --git a/modules/ROOT/attachments/availability/gartner_complexity_reduces_uptime.pdf b/modules/admin/attachments/availability/gartner_complexity_reduces_uptime.pdf similarity index 100% rename from modules/ROOT/attachments/availability/gartner_complexity_reduces_uptime.pdf rename to modules/admin/attachments/availability/gartner_complexity_reduces_uptime.pdf diff --git a/modules/ROOT/examples/.gitkeep b/modules/admin/examples/.gitkeep similarity index 100% rename from modules/ROOT/examples/.gitkeep rename to modules/admin/examples/.gitkeep diff --git a/modules/ROOT/examples/deployment/gdpr/personal_data_export.json b/modules/admin/examples/deployment/gdpr/personal_data_export.json similarity index 100% rename from modules/ROOT/examples/deployment/gdpr/personal_data_export.json rename to modules/admin/examples/deployment/gdpr/personal_data_export.json diff --git a/modules/ROOT/images/.gitkeep b/modules/admin/images/.gitkeep similarity index 100% rename from modules/ROOT/images/.gitkeep rename to modules/admin/images/.gitkeep diff --git a/modules/ROOT/images/architecture/c4-ocis-system-container.svg b/modules/admin/images/architecture/c4-ocis-system-container.svg similarity index 100% rename from modules/ROOT/images/architecture/c4-ocis-system-container.svg rename to modules/admin/images/architecture/c4-ocis-system-container.svg diff --git a/modules/ROOT/images/architecture/c4-ocis-system-context.svg b/modules/admin/images/architecture/c4-ocis-system-context.svg similarity index 100% rename from modules/ROOT/images/architecture/c4-ocis-system-context.svg rename to modules/admin/images/architecture/c4-ocis-system-context.svg diff --git a/modules/ROOT/images/architecture/idea.drawio.svg b/modules/admin/images/architecture/idea.drawio.svg similarity index 100% rename from modules/ROOT/images/architecture/idea.drawio.svg rename to modules/admin/images/architecture/idea.drawio.svg diff --git a/modules/ROOT/images/architecture/infinite_scale_data_platform.svg b/modules/admin/images/architecture/infinite_scale_data_platform.svg similarity index 100% rename from modules/ROOT/images/architecture/infinite_scale_data_platform.svg rename to modules/admin/images/architecture/infinite_scale_data_platform.svg diff --git a/modules/ROOT/images/availability_scaling/a_a_cluster_with_data_server.svg b/modules/admin/images/availability_scaling/a_a_cluster_with_data_server.svg similarity index 100% rename from modules/ROOT/images/availability_scaling/a_a_cluster_with_data_server.svg rename to modules/admin/images/availability_scaling/a_a_cluster_with_data_server.svg diff --git a/modules/ROOT/images/availability_scaling/a_a_ha_with_data_server.svg b/modules/admin/images/availability_scaling/a_a_ha_with_data_server.svg similarity index 100% rename from modules/ROOT/images/availability_scaling/a_a_ha_with_data_server.svg rename to modules/admin/images/availability_scaling/a_a_ha_with_data_server.svg diff --git a/modules/ROOT/images/availability_scaling/container_evolution.svg b/modules/admin/images/availability_scaling/container_evolution.svg similarity index 100% rename from modules/ROOT/images/availability_scaling/container_evolution.svg rename to modules/admin/images/availability_scaling/container_evolution.svg diff --git a/modules/ROOT/images/availability_scaling/containerized_applications.svg b/modules/admin/images/availability_scaling/containerized_applications.svg similarity index 100% rename from modules/ROOT/images/availability_scaling/containerized_applications.svg rename to modules/admin/images/availability_scaling/containerized_applications.svg diff --git a/modules/ROOT/images/availability_scaling/ocis_with_data_server.svg b/modules/admin/images/availability_scaling/ocis_with_data_server.svg similarity index 100% rename from modules/ROOT/images/availability_scaling/ocis_with_data_server.svg rename to modules/admin/images/availability_scaling/ocis_with_data_server.svg diff --git a/modules/ROOT/images/availability_scaling/scale_out.svg b/modules/admin/images/availability_scaling/scale_out.svg similarity index 100% rename from modules/ROOT/images/availability_scaling/scale_out.svg rename to modules/admin/images/availability_scaling/scale_out.svg diff --git a/modules/ROOT/images/availability_scaling/scale_up.svg b/modules/admin/images/availability_scaling/scale_up.svg similarity index 100% rename from modules/ROOT/images/availability_scaling/scale_up.svg rename to modules/admin/images/availability_scaling/scale_up.svg diff --git a/modules/ROOT/images/availability_scaling/single_server_with_disks.svg b/modules/admin/images/availability_scaling/single_server_with_disks.svg similarity index 100% rename from modules/ROOT/images/availability_scaling/single_server_with_disks.svg rename to modules/admin/images/availability_scaling/single_server_with_disks.svg diff --git a/modules/ROOT/images/depl-examples/federation/science_mesh/sm_OpenCloudMesh_min.png b/modules/admin/images/depl-examples/federation/science_mesh/sm_OpenCloudMesh_min.png similarity index 100% rename from modules/ROOT/images/depl-examples/federation/science_mesh/sm_OpenCloudMesh_min.png rename to modules/admin/images/depl-examples/federation/science_mesh/sm_OpenCloudMesh_min.png diff --git a/modules/ROOT/images/depl-examples/federation/science_mesh/sm_federation_a_setup.png b/modules/admin/images/depl-examples/federation/science_mesh/sm_federation_a_setup.png similarity index 100% rename from modules/ROOT/images/depl-examples/federation/science_mesh/sm_federation_a_setup.png rename to modules/admin/images/depl-examples/federation/science_mesh/sm_federation_a_setup.png diff --git a/modules/ROOT/images/depl-examples/federation/science_mesh/sm_federation_b_setup.png b/modules/admin/images/depl-examples/federation/science_mesh/sm_federation_b_setup.png similarity index 100% rename from modules/ROOT/images/depl-examples/federation/science_mesh/sm_federation_b_setup.png rename to modules/admin/images/depl-examples/federation/science_mesh/sm_federation_b_setup.png diff --git a/modules/ROOT/images/depl-examples/federation/science_mesh/sm_invitations.png b/modules/admin/images/depl-examples/federation/science_mesh/sm_invitations.png similarity index 100% rename from modules/ROOT/images/depl-examples/federation/science_mesh/sm_invitations.png rename to modules/admin/images/depl-examples/federation/science_mesh/sm_invitations.png diff --git a/modules/ROOT/images/depl-examples/federation/science_mesh/sm_science_mesh_logo.svg b/modules/admin/images/depl-examples/federation/science_mesh/sm_science_mesh_logo.svg similarity index 100% rename from modules/ROOT/images/depl-examples/federation/science_mesh/sm_science_mesh_logo.svg rename to modules/admin/images/depl-examples/federation/science_mesh/sm_science_mesh_logo.svg diff --git a/modules/ROOT/images/depl-examples/federation/science_mesh/sm_select_app.png b/modules/admin/images/depl-examples/federation/science_mesh/sm_select_app.png similarity index 100% rename from modules/ROOT/images/depl-examples/federation/science_mesh/sm_select_app.png rename to modules/admin/images/depl-examples/federation/science_mesh/sm_select_app.png diff --git a/modules/ROOT/images/depl-examples/federation/science_mesh/sm_user_accept_token.png b/modules/admin/images/depl-examples/federation/science_mesh/sm_user_accept_token.png similarity index 100% rename from modules/ROOT/images/depl-examples/federation/science_mesh/sm_user_accept_token.png rename to modules/admin/images/depl-examples/federation/science_mesh/sm_user_accept_token.png diff --git a/modules/ROOT/images/depl-examples/federation/science_mesh/sm_user_generate_invite.png b/modules/admin/images/depl-examples/federation/science_mesh/sm_user_generate_invite.png similarity index 100% rename from modules/ROOT/images/depl-examples/federation/science_mesh/sm_user_generate_invite.png rename to modules/admin/images/depl-examples/federation/science_mesh/sm_user_generate_invite.png diff --git a/modules/ROOT/images/depl-examples/federation/science_mesh/sm_user_resource_shared.png b/modules/admin/images/depl-examples/federation/science_mesh/sm_user_resource_shared.png similarity index 100% rename from modules/ROOT/images/depl-examples/federation/science_mesh/sm_user_resource_shared.png rename to modules/admin/images/depl-examples/federation/science_mesh/sm_user_resource_shared.png diff --git a/modules/ROOT/images/depl-examples/federation/science_mesh/sm_user_share_resource_search.png b/modules/admin/images/depl-examples/federation/science_mesh/sm_user_share_resource_search.png similarity index 100% rename from modules/ROOT/images/depl-examples/federation/science_mesh/sm_user_share_resource_search.png rename to modules/admin/images/depl-examples/federation/science_mesh/sm_user_share_resource_search.png diff --git a/modules/ROOT/images/depl-examples/federation/science_mesh/sm_user_share_resource_selected.png b/modules/admin/images/depl-examples/federation/science_mesh/sm_user_share_resource_selected.png similarity index 100% rename from modules/ROOT/images/depl-examples/federation/science_mesh/sm_user_share_resource_selected.png rename to modules/admin/images/depl-examples/federation/science_mesh/sm_user_share_resource_selected.png diff --git a/modules/ROOT/images/depl-examples/federation/science_mesh/sm_user_token_generated.png b/modules/admin/images/depl-examples/federation/science_mesh/sm_user_token_generated.png similarity index 100% rename from modules/ROOT/images/depl-examples/federation/science_mesh/sm_user_token_generated.png rename to modules/admin/images/depl-examples/federation/science_mesh/sm_user_token_generated.png diff --git a/modules/ROOT/images/depl-examples/ubuntu-compose/hetzner-create-new-project.png b/modules/admin/images/depl-examples/ubuntu-compose/hetzner-create-new-project.png similarity index 100% rename from modules/ROOT/images/depl-examples/ubuntu-compose/hetzner-create-new-project.png rename to modules/admin/images/depl-examples/ubuntu-compose/hetzner-create-new-project.png diff --git a/modules/ROOT/images/depl-examples/ubuntu-compose/hetzner-register-login.png b/modules/admin/images/depl-examples/ubuntu-compose/hetzner-register-login.png similarity index 100% rename from modules/ROOT/images/depl-examples/ubuntu-compose/hetzner-register-login.png rename to modules/admin/images/depl-examples/ubuntu-compose/hetzner-register-login.png diff --git a/modules/ROOT/images/depl-examples/ubuntu-compose/hetzner-select-cloud.png b/modules/admin/images/depl-examples/ubuntu-compose/hetzner-select-cloud.png similarity index 100% rename from modules/ROOT/images/depl-examples/ubuntu-compose/hetzner-select-cloud.png rename to modules/admin/images/depl-examples/ubuntu-compose/hetzner-select-cloud.png diff --git a/modules/ROOT/images/depl-examples/ubuntu-compose/hetzner-server-defined.png b/modules/admin/images/depl-examples/ubuntu-compose/hetzner-server-defined.png similarity index 100% rename from modules/ROOT/images/depl-examples/ubuntu-compose/hetzner-server-defined.png rename to modules/admin/images/depl-examples/ubuntu-compose/hetzner-server-defined.png diff --git a/modules/ROOT/images/depl-examples/ubuntu-compose/infinite-scale-logged-in.png b/modules/admin/images/depl-examples/ubuntu-compose/infinite-scale-logged-in.png similarity index 100% rename from modules/ROOT/images/depl-examples/ubuntu-compose/infinite-scale-logged-in.png rename to modules/admin/images/depl-examples/ubuntu-compose/infinite-scale-logged-in.png diff --git a/modules/ROOT/images/depl-examples/ubuntu-compose/infinite-scale-login.png b/modules/admin/images/depl-examples/ubuntu-compose/infinite-scale-login.png similarity index 100% rename from modules/ROOT/images/depl-examples/ubuntu-compose/infinite-scale-login.png rename to modules/admin/images/depl-examples/ubuntu-compose/infinite-scale-login.png diff --git a/modules/ROOT/images/depl-examples/ubuntu-compose/ubuntu-basic-teaser-image.png b/modules/admin/images/depl-examples/ubuntu-compose/ubuntu-basic-teaser-image.png similarity index 100% rename from modules/ROOT/images/depl-examples/ubuntu-compose/ubuntu-basic-teaser-image.png rename to modules/admin/images/depl-examples/ubuntu-compose/ubuntu-basic-teaser-image.png diff --git a/modules/ROOT/images/depl-examples/ubuntu-compose/ubuntu-hetzner-access.drawio.svg b/modules/admin/images/depl-examples/ubuntu-compose/ubuntu-hetzner-access.drawio.svg similarity index 100% rename from modules/ROOT/images/depl-examples/ubuntu-compose/ubuntu-hetzner-access.drawio.svg rename to modules/admin/images/depl-examples/ubuntu-compose/ubuntu-hetzner-access.drawio.svg diff --git a/modules/ROOT/images/depl-examples/ubuntu-compose/ubuntu-prod-install.drawio.svg b/modules/admin/images/depl-examples/ubuntu-compose/ubuntu-prod-install.drawio.svg similarity index 100% rename from modules/ROOT/images/depl-examples/ubuntu-compose/ubuntu-prod-install.drawio.svg rename to modules/admin/images/depl-examples/ubuntu-compose/ubuntu-prod-install.drawio.svg diff --git a/modules/ROOT/images/depl-examples/ubuntu-compose/ubuntu-server-access.drawio.svg b/modules/admin/images/depl-examples/ubuntu-compose/ubuntu-server-access.drawio.svg similarity index 100% rename from modules/ROOT/images/depl-examples/ubuntu-compose/ubuntu-server-access.drawio.svg rename to modules/admin/images/depl-examples/ubuntu-compose/ubuntu-server-access.drawio.svg diff --git a/modules/ROOT/images/deployment/gdpr/account-information.png b/modules/admin/images/deployment/gdpr/account-information.png similarity index 100% rename from modules/ROOT/images/deployment/gdpr/account-information.png rename to modules/admin/images/deployment/gdpr/account-information.png diff --git a/modules/ROOT/images/deployment/gdpr/configure-hidden-files.png b/modules/admin/images/deployment/gdpr/configure-hidden-files.png similarity index 100% rename from modules/ROOT/images/deployment/gdpr/configure-hidden-files.png rename to modules/admin/images/deployment/gdpr/configure-hidden-files.png diff --git a/modules/ROOT/images/deployment/gdpr/download-export.png b/modules/admin/images/deployment/gdpr/download-export.png similarity index 100% rename from modules/ROOT/images/deployment/gdpr/download-export.png rename to modules/admin/images/deployment/gdpr/download-export.png diff --git a/modules/ROOT/images/deployment/gdpr/show-hidden-files.png b/modules/admin/images/deployment/gdpr/show-hidden-files.png similarity index 100% rename from modules/ROOT/images/deployment/gdpr/show-hidden-files.png rename to modules/admin/images/deployment/gdpr/show-hidden-files.png diff --git a/modules/ROOT/images/deployment/services/concurrence.drawio.svg b/modules/admin/images/deployment/services/concurrence.drawio.svg similarity index 100% rename from modules/ROOT/images/deployment/services/concurrence.drawio.svg rename to modules/admin/images/deployment/services/concurrence.drawio.svg diff --git a/modules/ROOT/images/deployment/services/go_logo_blue.svg b/modules/admin/images/deployment/services/go_logo_blue.svg similarity index 100% rename from modules/ROOT/images/deployment/services/go_logo_blue.svg rename to modules/admin/images/deployment/services/go_logo_blue.svg diff --git a/modules/ROOT/images/deployment/services/graph/mermaid-graph.svg b/modules/admin/images/deployment/services/graph/mermaid-graph.svg similarity index 100% rename from modules/ROOT/images/deployment/services/graph/mermaid-graph.svg rename to modules/admin/images/deployment/services/graph/mermaid-graph.svg diff --git a/modules/ROOT/images/deployment/services/ocdav/mermaid-ocdav-1.svg b/modules/admin/images/deployment/services/ocdav/mermaid-ocdav-1.svg similarity index 100% rename from modules/ROOT/images/deployment/services/ocdav/mermaid-ocdav-1.svg rename to modules/admin/images/deployment/services/ocdav/mermaid-ocdav-1.svg diff --git a/modules/ROOT/images/deployment/services/ocdav/mermaid-ocdav-2.svg b/modules/admin/images/deployment/services/ocdav/mermaid-ocdav-2.svg similarity index 100% rename from modules/ROOT/images/deployment/services/ocdav/mermaid-ocdav-2.svg rename to modules/admin/images/deployment/services/ocdav/mermaid-ocdav-2.svg diff --git a/modules/ROOT/images/deployment/services/ocdav/mermaid-ocdav-3.svg b/modules/admin/images/deployment/services/ocdav/mermaid-ocdav-3.svg similarity index 100% rename from modules/ROOT/images/deployment/services/ocdav/mermaid-ocdav-3.svg rename to modules/admin/images/deployment/services/ocdav/mermaid-ocdav-3.svg diff --git a/modules/ROOT/images/deployment/services/ocdav/mermaid-ocdav-4.svg b/modules/admin/images/deployment/services/ocdav/mermaid-ocdav-4.svg similarity index 100% rename from modules/ROOT/images/deployment/services/ocdav/mermaid-ocdav-4.svg rename to modules/admin/images/deployment/services/ocdav/mermaid-ocdav-4.svg diff --git a/modules/ROOT/images/deployment/services/ocdav/mermaid-ocdav-5.svg b/modules/admin/images/deployment/services/ocdav/mermaid-ocdav-5.svg similarity index 100% rename from modules/ROOT/images/deployment/services/ocdav/mermaid-ocdav-5.svg rename to modules/admin/images/deployment/services/ocdav/mermaid-ocdav-5.svg diff --git a/modules/ROOT/images/deployment/services/runtime_c1.drawio.svg b/modules/admin/images/deployment/services/runtime_c1.drawio.svg similarity index 100% rename from modules/ROOT/images/deployment/services/runtime_c1.drawio.svg rename to modules/admin/images/deployment/services/runtime_c1.drawio.svg diff --git a/modules/ROOT/images/deployment/wopi/wopi-overview.svg b/modules/admin/images/deployment/wopi/wopi-overview.svg similarity index 100% rename from modules/ROOT/images/deployment/wopi/wopi-overview.svg rename to modules/admin/images/deployment/wopi/wopi-overview.svg diff --git a/modules/ROOT/images/monitoring/prometheus/prometheus_metrics.png b/modules/admin/images/monitoring/prometheus/prometheus_metrics.png similarity index 100% rename from modules/ROOT/images/monitoring/prometheus/prometheus_metrics.png rename to modules/admin/images/monitoring/prometheus/prometheus_metrics.png diff --git a/modules/admin/notes_for_the_navigation_file_nav.txt b/modules/admin/notes_for_the_navigation_file_nav.txt new file mode 100644 index 000000000..f86388b91 --- /dev/null +++ b/modules/admin/notes_for_the_navigation_file_nav.txt @@ -0,0 +1,13 @@ +The navigation files have been relocated and are accessed differently now. + +The main nav.adoc file is in ROOT and includes all nav.adoc files from the modules. To do so, the modules nav.adoc files needed to be relocated from: + +{modulesdir}/nav.adoc +to +{modulesdir}/partials/nav.adoc + +This is due to the fact that "Antora does not classify files located at the root of the module or in the modules folder" which means, there is no access path to a nav.adoc file which is located in the root of a module. + +As a result, the antora.yml file only contains the main ROOT/nav.adoc file. + +This is beneficial, as we now can structure products and their content in a better way. diff --git a/modules/ROOT/pages/additional-information/kb-documents/fail2ban-protect-login.adoc b/modules/admin/pages/additional-information/kb-documents/fail2ban-protect-login.adoc similarity index 100% rename from modules/ROOT/pages/additional-information/kb-documents/fail2ban-protect-login.adoc rename to modules/admin/pages/additional-information/kb-documents/fail2ban-protect-login.adoc diff --git a/modules/ROOT/pages/additional-information/knowledge-base.adoc b/modules/admin/pages/additional-information/knowledge-base.adoc similarity index 98% rename from modules/ROOT/pages/additional-information/knowledge-base.adoc rename to modules/admin/pages/additional-information/knowledge-base.adoc index c954ac8c7..93a9436f3 100644 --- a/modules/ROOT/pages/additional-information/knowledge-base.adoc +++ b/modules/admin/pages/additional-information/knowledge-base.adoc @@ -1,6 +1,8 @@ = Knowledge Base :toc: right :description: The Infinite Scale knowledge base provides setup examples, best practices, contributor-created content etc. that can be of interest to admins as a guide on how topics can be addressed. +:page-aliases: ROOT:additional-information/knowledge-base.adoc + :fail2ban_url: https://www.fail2ban.org/wiki/index.php/Main_Page :kb_path: additional-information/kb-documents diff --git a/modules/ROOT/pages/architecture/architecture.adoc b/modules/admin/pages/architecture/architecture.adoc similarity index 99% rename from modules/ROOT/pages/architecture/architecture.adoc rename to modules/admin/pages/architecture/architecture.adoc index 555525164..b8f674eba 100644 --- a/modules/ROOT/pages/architecture/architecture.adoc +++ b/modules/admin/pages/architecture/architecture.adoc @@ -2,6 +2,7 @@ :toc: right :toclevels: 4 :description: This page gives you an overview of the architecture and the concepts behind Infinite Scale. Infinite Scale was designed from the beginning as a data platform providing tools to integrate, organize, share and govern data and metadata. +:page-aliases: ROOT:architecture/architecture.adoc :c4-model-url: https://en.wikipedia.org/wiki/C4_model :suture-url: https://github.com/thejerf/suture diff --git a/modules/ROOT/pages/availability_scaling/availability_scaling.adoc b/modules/admin/pages/availability_scaling/availability_scaling.adoc similarity index 99% rename from modules/ROOT/pages/availability_scaling/availability_scaling.adoc rename to modules/admin/pages/availability_scaling/availability_scaling.adoc index 000b17e8b..8a2d8acdf 100644 --- a/modules/ROOT/pages/availability_scaling/availability_scaling.adoc +++ b/modules/admin/pages/availability_scaling/availability_scaling.adoc @@ -2,6 +2,7 @@ :toc: right :toclevels: 2 :description: There are many ways to achieve availability and scalability, but certain aspects depend on each other and decisions have to be considered carefully to optimize the outcome. This guide gives a brief overview about running a modern, microservices-based software like Infinite Scale as a single or distributed instance. +:page-aliases: ROOT:availability_scaling/availability_scaling.adoc :gartner_complexity_url: https://blogs.gartner.com/ephraim-baron/how-systems-complexity-reduces-uptime/ :what_is_kubernetes_url: https://kubernetes.io/docs/concepts/overview/what-is-kubernetes/ diff --git a/modules/ROOT/pages/conf-examples/office/office-integration.adoc b/modules/admin/pages/conf-examples/office/office-integration.adoc similarity index 94% rename from modules/ROOT/pages/conf-examples/office/office-integration.adoc rename to modules/admin/pages/conf-examples/office/office-integration.adoc index 3a31e6b18..8f5114159 100644 --- a/modules/ROOT/pages/conf-examples/office/office-integration.adoc +++ b/modules/admin/pages/conf-examples/office/office-integration.adoc @@ -1,6 +1,7 @@ = Integrating Office Applications :toc: right :description: If you configure the Infinite Scale collaboration service, you can integrate major office applications like Collabora, ONLYOFFICE or Microsoft Online. +:page-aliases: ROOT:conf-examples/office/office-integration.adoc :traefik_url: https://traefik.io/traefik/ diff --git a/modules/ROOT/pages/conf-examples/search/configure-search.adoc b/modules/admin/pages/conf-examples/search/configure-search.adoc similarity index 98% rename from modules/ROOT/pages/conf-examples/search/configure-search.adoc rename to modules/admin/pages/conf-examples/search/configure-search.adoc index 40d4eaeea..975cb83c8 100644 --- a/modules/ROOT/pages/conf-examples/search/configure-search.adoc +++ b/modules/admin/pages/conf-examples/search/configure-search.adoc @@ -2,6 +2,7 @@ :toc: right :toclevels: 3 :description: This document gives some guidance and notes about how to configure the search service. +:page-aliases: ROOT:conf-examples/search/configure-search.adoc :tika-version: 3.2.0 :configure-tika-url: https://tika.apache.org/{tika-version}/configuring.html diff --git a/modules/ROOT/pages/depl-examples/federation/sciencemesh.adoc b/modules/admin/pages/depl-examples/federation/sciencemesh.adoc similarity index 99% rename from modules/ROOT/pages/depl-examples/federation/sciencemesh.adoc rename to modules/admin/pages/depl-examples/federation/sciencemesh.adoc index ed24a1e2b..0f15fc292 100644 --- a/modules/ROOT/pages/depl-examples/federation/sciencemesh.adoc +++ b/modules/admin/pages/depl-examples/federation/sciencemesh.adoc @@ -3,6 +3,7 @@ :toclevels: 3 :keywords: federation, sciencemesh, ocm :description: This document will guide you through setting up a federation between users of Infinite Scale instances using the ScienceMesh framework, which includes the Open Cloud Mesh (OCM) technology. +:page-aliases: ROOT:depl-examples/federation/sciencemesh.adoc image:depl-examples/federation/science_mesh/sm_OpenCloudMesh_min.png[Teaser Image, width=500] diff --git a/modules/ROOT/pages/depl-examples/ubuntu-compose/ubuntu-compose-hetzner.adoc b/modules/admin/pages/depl-examples/ubuntu-compose/ubuntu-compose-hetzner.adoc similarity index 98% rename from modules/ROOT/pages/depl-examples/ubuntu-compose/ubuntu-compose-hetzner.adoc rename to modules/admin/pages/depl-examples/ubuntu-compose/ubuntu-compose-hetzner.adoc index 33138df3f..02c7b39a1 100644 --- a/modules/ROOT/pages/depl-examples/ubuntu-compose/ubuntu-compose-hetzner.adoc +++ b/modules/admin/pages/depl-examples/ubuntu-compose/ubuntu-compose-hetzner.adoc @@ -3,6 +3,7 @@ :toclevels: 3 :keywords: docker compose, raspberry pi, install, ocis, infinite scale, letsencrypt :description: Install Infinite Scale using Docker Compose on the Hetzner Cloud for production use. +:page-aliases: ROOT:depl-examples/ubuntu-compose/ubuntu-compose-hetzner.adoc include::partial$multi-location/compose-version.adoc[] diff --git a/modules/ROOT/pages/depl-examples/ubuntu-compose/ubuntu-compose-prod.adoc b/modules/admin/pages/depl-examples/ubuntu-compose/ubuntu-compose-prod.adoc similarity index 92% rename from modules/ROOT/pages/depl-examples/ubuntu-compose/ubuntu-compose-prod.adoc rename to modules/admin/pages/depl-examples/ubuntu-compose/ubuntu-compose-prod.adoc index 8d7ba41bc..32e7c9740 100644 --- a/modules/ROOT/pages/depl-examples/ubuntu-compose/ubuntu-compose-prod.adoc +++ b/modules/admin/pages/depl-examples/ubuntu-compose/ubuntu-compose-prod.adoc @@ -1,11 +1,16 @@ = Install Infinite Scale on a Server :toc: macro :toclevels: 3 -:page-aliases: depl-examples/minimal-bare-metal.adoc, depl-examples/bare-metal.adoc, \ -depl-examples/small-scale.adoc, deployment/systemd.adoc, quickguide/quickguide.adoc, \ -depl-examples/container-setup.adoc :keywords: docker compose, raspberry pi, install, ocis, infinite scale, letsencrypt :description: Install Infinite Scale using Docker Compose on a server for production use. +:page-aliases: \ +ROOT:depl-examples/ubuntu-compose/ubuntu-compose-prod.adoc, \ +ROOT:depl-examples/minimal-bare-metal.adoc, \ +ROOT:depl-examples/bare-metal.adoc, \ +ROOT:depl-examples/small-scale.adoc, \ +ROOT:depl-examples/container-setup.adoc, \ +ROOT:deployment/systemd.adoc, \ +ROOT:quickguide/quickguide.adoc include::partial$multi-location/compose-version.adoc[] diff --git a/modules/ROOT/pages/deployment/gdpr/gdpr.adoc b/modules/admin/pages/deployment/gdpr/gdpr.adoc similarity index 98% rename from modules/ROOT/pages/deployment/gdpr/gdpr.adoc rename to modules/admin/pages/deployment/gdpr/gdpr.adoc index 59e7c4254..997ee3841 100644 --- a/modules/ROOT/pages/deployment/gdpr/gdpr.adoc +++ b/modules/admin/pages/deployment/gdpr/gdpr.adoc @@ -1,6 +1,7 @@ = User-Triggered GDPR Report :toc: right :description: Starting with version 3 of Infinite Scale, users can create a General Data Protection Regulation (GDPR) report about the use of their own data in Infinite Scale at any time. +:page-aliases: ROOT:deployment/gdpr/gdpr.adoc == Introduction diff --git a/modules/ROOT/pages/deployment/general/general-info.adoc b/modules/admin/pages/deployment/general/general-info.adoc similarity index 99% rename from modules/ROOT/pages/deployment/general/general-info.adoc rename to modules/admin/pages/deployment/general/general-info.adoc index a48e58c03..8c29fc98f 100644 --- a/modules/ROOT/pages/deployment/general/general-info.adoc +++ b/modules/admin/pages/deployment/general/general-info.adoc @@ -1,6 +1,7 @@ = General Information :toc: right :description: This document covers general aspects of Infinite Scale like start modes, services, important minimum configuration etc. for a common understanding. +:page-aliases: ROOT:deployment/general/general-info.adoc == Introduction diff --git a/modules/ROOT/pages/deployment/general/ocis-init.adoc b/modules/admin/pages/deployment/general/ocis-init.adoc similarity index 98% rename from modules/ROOT/pages/deployment/general/ocis-init.adoc rename to modules/admin/pages/deployment/general/ocis-init.adoc index 4438da467..212347eaf 100644 --- a/modules/ROOT/pages/deployment/general/ocis-init.adoc +++ b/modules/admin/pages/deployment/general/ocis-init.adoc @@ -1,6 +1,7 @@ = The ocis init Command :toc: right :description: When setting up Infinite Scale, the ocis init command can be used for basic configuration but is not suitable for all environments. This document describes the details. +:page-aliases: ROOT:deployment/general/ocis-init.adoc == Introduction diff --git a/modules/ROOT/pages/deployment/index.adoc b/modules/admin/pages/deployment/index.adoc similarity index 95% rename from modules/ROOT/pages/deployment/index.adoc rename to modules/admin/pages/deployment/index.adoc index d16bec199..10542b994 100644 --- a/modules/ROOT/pages/deployment/index.adoc +++ b/modules/admin/pages/deployment/index.adoc @@ -1,6 +1,7 @@ = Deployment :toc: right :description: There are several deployment options for Infinite Scale available. Consider which one serves your purposes best. Generally speaking, you can decide between using containers or manually set up a regular server. +:page-aliases: ROOT:deployment/index.adoc {description} diff --git a/modules/ROOT/pages/deployment/security/security.adoc b/modules/admin/pages/deployment/security/security.adoc similarity index 95% rename from modules/ROOT/pages/deployment/security/security.adoc rename to modules/admin/pages/deployment/security/security.adoc index 11e929b08..10a8b0705 100644 --- a/modules/ROOT/pages/deployment/security/security.adoc +++ b/modules/admin/pages/deployment/security/security.adoc @@ -1,6 +1,7 @@ = Securing Infinite Scale :toc: right :description: As with any system accessible via the web, Infinite Scale also needs to be secured via classical methods on the front-end side. You know best what's necessary for your environment. However, demo users which can be created on initialization should definitely be removed before going into production. +:page-aliases: ROOT:deployment/security/security.adoc == Introduction diff --git a/modules/ROOT/pages/deployment/services/caching.adoc b/modules/admin/pages/deployment/services/caching.adoc similarity index 99% rename from modules/ROOT/pages/deployment/services/caching.adoc rename to modules/admin/pages/deployment/services/caching.adoc index 8b4d10a30..07dd051e1 100644 --- a/modules/ROOT/pages/deployment/services/caching.adoc +++ b/modules/admin/pages/deployment/services/caching.adoc @@ -1,6 +1,7 @@ = Caching and Persistence :toc: right :description: Caching can not only be a big boost to performance but can also be essential when setting up Infinite Scale via container orchestration. +:page-aliases: ROOT:deployment/services/caching.adoc == Introduction diff --git a/modules/ROOT/pages/deployment/services/deployment-considerations.adoc b/modules/admin/pages/deployment/services/deployment-considerations.adoc similarity index 96% rename from modules/ROOT/pages/deployment/services/deployment-considerations.adoc rename to modules/admin/pages/deployment/services/deployment-considerations.adoc index 7298cccc8..2b60f75a7 100644 --- a/modules/ROOT/pages/deployment/services/deployment-considerations.adoc +++ b/modules/admin/pages/deployment/services/deployment-considerations.adoc @@ -1,6 +1,7 @@ = Deployment Considerations :toc: right :description: When using container orchestration, some considerations should be taken into account when deploying services with respect to scaling. +:page-aliases: ROOT:deployment/services/deployment-considerations.adoc :nats-clustering-url: https://docs.nats.io/running-a-nats-service/configuration/clustering diff --git a/modules/ROOT/pages/deployment/services/env-var-changes.adoc b/modules/admin/pages/deployment/services/env-var-changes.adoc similarity index 93% rename from modules/ROOT/pages/deployment/services/env-var-changes.adoc rename to modules/admin/pages/deployment/services/env-var-changes.adoc index e9085b3f2..ed8ce2a4c 100644 --- a/modules/ROOT/pages/deployment/services/env-var-changes.adoc +++ b/modules/admin/pages/deployment/services/env-var-changes.adoc @@ -1,6 +1,7 @@ # Changed Environment Variables in Versions :toc: right :description: This page contains tables with added and removed environment variables between Infinite Scale version 7.3.0 and 8.0.0. +:page-aliases: ROOT:deployment/services/env-var-changes.adoc :source_path: {ocis_services_raw_url}{service_url_component}{ocis_services_env_var_deltas_path} diff --git a/modules/ROOT/pages/deployment/services/env-var-note.adoc b/modules/admin/pages/deployment/services/env-var-note.adoc similarity index 98% rename from modules/ROOT/pages/deployment/services/env-var-note.adoc rename to modules/admin/pages/deployment/services/env-var-note.adoc index 7c02b88bc..13ddd8315 100644 --- a/modules/ROOT/pages/deployment/services/env-var-note.adoc +++ b/modules/admin/pages/deployment/services/env-var-note.adoc @@ -1,6 +1,7 @@ = Notes for Environment Variables :toc: right :description: Environment variables are key to configure Infinite Scale. To understand variables in a proper way, some notes are made. +:page-aliases: ROOT:deployment/services/env-var-note.adoc == Introduction diff --git a/modules/ROOT/pages/deployment/services/env-vars-special-scope.adoc b/modules/admin/pages/deployment/services/env-vars-special-scope.adoc similarity index 97% rename from modules/ROOT/pages/deployment/services/env-vars-special-scope.adoc rename to modules/admin/pages/deployment/services/env-vars-special-scope.adoc index 64ada7f09..2fef2fd37 100644 --- a/modules/ROOT/pages/deployment/services/env-vars-special-scope.adoc +++ b/modules/admin/pages/deployment/services/env-vars-special-scope.adoc @@ -1,6 +1,7 @@ = Environment Variables with Special Scopes :toc: right :description: Some environment variables have a special, extended or global scope. Variables with special scope are related to a deployment method only. +:page-aliases: ROOT:deployment/services/env-vars-special-scope.adoc == Introduction diff --git a/modules/ROOT/pages/deployment/services/envvar-types-description.adoc b/modules/admin/pages/deployment/services/envvar-types-description.adoc similarity index 100% rename from modules/ROOT/pages/deployment/services/envvar-types-description.adoc rename to modules/admin/pages/deployment/services/envvar-types-description.adoc diff --git a/modules/ROOT/pages/deployment/services/gateways.adoc b/modules/admin/pages/deployment/services/gateways.adoc similarity index 95% rename from modules/ROOT/pages/deployment/services/gateways.adoc rename to modules/admin/pages/deployment/services/gateways.adoc index 839e3840f..21eb2699c 100644 --- a/modules/ROOT/pages/deployment/services/gateways.adoc +++ b/modules/admin/pages/deployment/services/gateways.adoc @@ -1,6 +1,7 @@ = Gateways :toc: right :description: There is more than one service providing API gateway functionalities. The following explanation helps sorting things out. +:page-aliases: ROOT:deployment/services/gateways.adoc == Introduction diff --git a/modules/ROOT/pages/deployment/services/logging.adoc b/modules/admin/pages/deployment/services/logging.adoc similarity index 98% rename from modules/ROOT/pages/deployment/services/logging.adoc rename to modules/admin/pages/deployment/services/logging.adoc index fee261c86..37c1e9fb4 100644 --- a/modules/ROOT/pages/deployment/services/logging.adoc +++ b/modules/admin/pages/deployment/services/logging.adoc @@ -1,6 +1,7 @@ = Logging :toc: right :description: Setting the proper log level is a way of filtering important information about the state of Infinite Scale. Depending on what you are looking for, the log output will be more or less verbose. +:page-aliases: ROOT:deployment/services/logging.adoc == Introduction diff --git a/modules/ROOT/pages/deployment/services/ports-used.adoc b/modules/admin/pages/deployment/services/ports-used.adoc similarity index 98% rename from modules/ROOT/pages/deployment/services/ports-used.adoc rename to modules/admin/pages/deployment/services/ports-used.adoc index bcb0f7255..37e182b58 100644 --- a/modules/ROOT/pages/deployment/services/ports-used.adoc +++ b/modules/admin/pages/deployment/services/ports-used.adoc @@ -1,6 +1,7 @@ = Ports Used :toc: right :description: Infinite Scale uses ports for communication between services. This page provides an overview of default port ranges. +:page-aliases: ROOT:deployment/services/ports-used.adoc == Introduction diff --git a/modules/ROOT/pages/deployment/services/registry.adoc b/modules/admin/pages/deployment/services/registry.adoc similarity index 95% rename from modules/ROOT/pages/deployment/services/registry.adoc rename to modules/admin/pages/deployment/services/registry.adoc index de6375b56..4de337159 100644 --- a/modules/ROOT/pages/deployment/services/registry.adoc +++ b/modules/admin/pages/deployment/services/registry.adoc @@ -1,6 +1,7 @@ = Registry :toc: right :description: All services need to be able to communicate with each other. To do so, they register in a common registry. +:page-aliases: ROOT:deployment/services/registry.adoc == Introduction diff --git a/modules/ROOT/pages/deployment/services/s-list/activitylog.adoc b/modules/admin/pages/deployment/services/s-list/activitylog.adoc similarity index 93% rename from modules/ROOT/pages/deployment/services/s-list/activitylog.adoc rename to modules/admin/pages/deployment/services/s-list/activitylog.adoc index b1cdbad4f..a9b03ef0f 100644 --- a/modules/ROOT/pages/deployment/services/s-list/activitylog.adoc +++ b/modules/admin/pages/deployment/services/s-list/activitylog.adoc @@ -1,6 +1,7 @@ = Activitylog :toc: right :description: The Infinite Scale activitylog service is responsible for storing events (activities) per resource. +:page-aliases: ROOT:deployment/services/s-list/activitylog.adoc :service_name: activitylog diff --git a/modules/ROOT/pages/deployment/services/s-list/antivirus.adoc b/modules/admin/pages/deployment/services/s-list/antivirus.adoc similarity index 98% rename from modules/ROOT/pages/deployment/services/s-list/antivirus.adoc rename to modules/admin/pages/deployment/services/s-list/antivirus.adoc index b2973ecdd..d20229adc 100644 --- a/modules/ROOT/pages/deployment/services/s-list/antivirus.adoc +++ b/modules/admin/pages/deployment/services/s-list/antivirus.adoc @@ -1,6 +1,7 @@ = Antivirus Service Configuration :toc: right :description: The Infinite Scale antivirus service is responsible for scanning files for viruses. +:page-aliases: ROOT:deployment/services/s-list/antivirus.adoc :service_name: antivirus diff --git a/modules/ROOT/pages/deployment/services/s-list/app-provider.adoc b/modules/admin/pages/deployment/services/s-list/app-provider.adoc similarity index 90% rename from modules/ROOT/pages/deployment/services/s-list/app-provider.adoc rename to modules/admin/pages/deployment/services/s-list/app-provider.adoc index 86e83ba01..915a5b7b0 100644 --- a/modules/ROOT/pages/deployment/services/s-list/app-provider.adoc +++ b/modules/admin/pages/deployment/services/s-list/app-provider.adoc @@ -1,6 +1,7 @@ = App Provider Service Configuration :toc: right :description: App providers represent apps that are not able to register themselves. Currently there is only the CS3org WOPI server app provider. +:page-aliases: ROOT:deployment/services/s-list/app-provider.adoc :service_name: app-provider diff --git a/modules/ROOT/pages/deployment/services/s-list/app-registry.adoc b/modules/admin/pages/deployment/services/s-list/app-registry.adoc similarity index 98% rename from modules/ROOT/pages/deployment/services/s-list/app-registry.adoc rename to modules/admin/pages/deployment/services/s-list/app-registry.adoc index 340e54680..44ac3a765 100644 --- a/modules/ROOT/pages/deployment/services/s-list/app-registry.adoc +++ b/modules/admin/pages/deployment/services/s-list/app-registry.adoc @@ -1,6 +1,7 @@ = App-Registry Service Configuration :toc: right :description: The Infinite Scale App-Registry service is the single point where all apps register themselves and their respective supported mime types. +:page-aliases: ROOT:deployment/services/s-list/app-registry.adoc :service_name: app-registry diff --git a/modules/ROOT/pages/deployment/services/s-list/audit.adoc b/modules/admin/pages/deployment/services/s-list/audit.adoc similarity index 97% rename from modules/ROOT/pages/deployment/services/s-list/audit.adoc rename to modules/admin/pages/deployment/services/s-list/audit.adoc index 2874faf9f..1790518f4 100644 --- a/modules/ROOT/pages/deployment/services/s-list/audit.adoc +++ b/modules/admin/pages/deployment/services/s-list/audit.adoc @@ -1,6 +1,7 @@ = Audit Service Configuration :toc: right :description: The audit service logs all events of the system as an audit log. With audit logs, you are able to prove compliance with corporate and legal guidelines as well as enable reporting and auditing of operations. +:page-aliases: ROOT:deployment/services/s-list/audit.adoc :service_name: audit diff --git a/modules/ROOT/pages/deployment/services/s-list/auth-app.adoc b/modules/admin/pages/deployment/services/s-list/auth-app.adoc similarity index 99% rename from modules/ROOT/pages/deployment/services/s-list/auth-app.adoc rename to modules/admin/pages/deployment/services/s-list/auth-app.adoc index 741d76c27..539e6565a 100644 --- a/modules/ROOT/pages/deployment/services/s-list/auth-app.adoc +++ b/modules/admin/pages/deployment/services/s-list/auth-app.adoc @@ -1,10 +1,10 @@ = Auth App Service Configuration :toc: right +:description: The Infinite Scale Auth App service provides authentication for 3rd party apps. +:page-aliases: ROOT:deployment/services/s-list/auth-app.adoc :service_name: auth-app -:description: The Infinite Scale Auth App service provides authentication for 3rd party apps. - == Introduction {description} diff --git a/modules/ROOT/pages/deployment/services/s-list/auth-basic.adoc b/modules/admin/pages/deployment/services/s-list/auth-basic.adoc similarity index 93% rename from modules/ROOT/pages/deployment/services/s-list/auth-basic.adoc rename to modules/admin/pages/deployment/services/s-list/auth-basic.adoc index 4cb25f705..aa8577be7 100644 --- a/modules/ROOT/pages/deployment/services/s-list/auth-basic.adoc +++ b/modules/admin/pages/deployment/services/s-list/auth-basic.adoc @@ -1,10 +1,10 @@ = Auth Basic Service Configuration :toc: right +:description: The Infinite Scale Auth Basic service provides basic authentication for those clients who cannot handle O> +:page-aliases: ROOT:deployment/services/s-list/auth-basic.adoc :service_name: auth-basic -:description: The Infinite Scale Auth Basic service provides basic authentication for those clients who cannot handle OIDC. This is a rare case, is usually not necessary and mainly used for tests or development. - == Introduction {description} diff --git a/modules/ROOT/pages/deployment/services/s-list/auth-bearer.adoc b/modules/admin/pages/deployment/services/s-list/auth-bearer.adoc similarity index 95% rename from modules/ROOT/pages/deployment/services/s-list/auth-bearer.adoc rename to modules/admin/pages/deployment/services/s-list/auth-bearer.adoc index fc270866c..b575edfc3 100644 --- a/modules/ROOT/pages/deployment/services/s-list/auth-bearer.adoc +++ b/modules/admin/pages/deployment/services/s-list/auth-bearer.adoc @@ -1,6 +1,7 @@ = Auth Bearer Service Configuration :toc: right :description: The Infinite Scale Auth Bearer service authenticates OpenID Connect bearer tokens. +:page-aliases: ROOT:deployment/services/s-list/auth-bearer.adoc :service_name: auth-bearer diff --git a/modules/ROOT/pages/deployment/services/s-list/auth-machine.adoc b/modules/admin/pages/deployment/services/s-list/auth-machine.adoc similarity index 94% rename from modules/ROOT/pages/deployment/services/s-list/auth-machine.adoc rename to modules/admin/pages/deployment/services/s-list/auth-machine.adoc index 4ccf17a01..886a6bce0 100644 --- a/modules/ROOT/pages/deployment/services/s-list/auth-machine.adoc +++ b/modules/admin/pages/deployment/services/s-list/auth-machine.adoc @@ -1,6 +1,7 @@ = Auth Machine Service Configuration :toc: right :description: The Infinite Scale Auth Machine service +:page-aliases: ROOT:deployment/services/s-list/auth-machine.adoc :service_name: auth-machine diff --git a/modules/ROOT/pages/deployment/services/s-list/auth-service.adoc b/modules/admin/pages/deployment/services/s-list/auth-service.adoc similarity index 95% rename from modules/ROOT/pages/deployment/services/s-list/auth-service.adoc rename to modules/admin/pages/deployment/services/s-list/auth-service.adoc index 990606eac..91c7a07ac 100644 --- a/modules/ROOT/pages/deployment/services/s-list/auth-service.adoc +++ b/modules/admin/pages/deployment/services/s-list/auth-service.adoc @@ -1,6 +1,7 @@ = Auth Service Configuration :toc: right :description: The Infinite Scale Auth Service is used to authenticate service accounts. Compared to normal accounts, service accounts are Infinite Scale internal only and not available to ordinary users like via LDAP. +:page-aliases: ROOT:deployment/services/s-list/auth-service.adoc :service_name: auth-service diff --git a/modules/ROOT/pages/deployment/services/s-list/clientlog.adoc b/modules/admin/pages/deployment/services/s-list/clientlog.adoc similarity index 93% rename from modules/ROOT/pages/deployment/services/s-list/clientlog.adoc rename to modules/admin/pages/deployment/services/s-list/clientlog.adoc index 6e1ba3092..a303361e8 100644 --- a/modules/ROOT/pages/deployment/services/s-list/clientlog.adoc +++ b/modules/admin/pages/deployment/services/s-list/clientlog.adoc @@ -1,6 +1,7 @@ = Clientlog Configuration :toc: right :description: The Infinite Scale clientlog service is responsible for composing machine-readable notifications for clients. Clients are apps and web interfaces. +:page-aliases: ROOT:deployment/services/s-list/clientlog.adoc :service_name: clientlog diff --git a/modules/ROOT/pages/deployment/services/s-list/collaboration.adoc b/modules/admin/pages/deployment/services/s-list/collaboration.adoc similarity index 98% rename from modules/ROOT/pages/deployment/services/s-list/collaboration.adoc rename to modules/admin/pages/deployment/services/s-list/collaboration.adoc index 19840e4bc..949bee53d 100644 --- a/modules/ROOT/pages/deployment/services/s-list/collaboration.adoc +++ b/modules/admin/pages/deployment/services/s-list/collaboration.adoc @@ -1,6 +1,7 @@ = Collaboration :toc: right :description: The collaboration service connects Infinite Scale with document servers such as Collabora, ONLYOFFICE or Microsoft using the WOPI protocol. +:page-aliases: ROOT:deployment/services/s-list/collaboration.adoc :service_name: collaboration diff --git a/modules/ROOT/pages/deployment/services/s-list/eventhistory.adoc b/modules/admin/pages/deployment/services/s-list/eventhistory.adoc similarity index 94% rename from modules/ROOT/pages/deployment/services/s-list/eventhistory.adoc rename to modules/admin/pages/deployment/services/s-list/eventhistory.adoc index 0648041f1..1283f4531 100644 --- a/modules/ROOT/pages/deployment/services/s-list/eventhistory.adoc +++ b/modules/admin/pages/deployment/services/s-list/eventhistory.adoc @@ -1,6 +1,7 @@ = Eventhistory Service Configuration :toc: right :description: The Infinite Scale eventhistory service consumes all events from the configured event system like NATS, stores them and allows other services to retrieve them via an event ID. +:page-aliases: ROOT:deployment/services/s-list/eventhistory.adoc :service_name: eventhistory diff --git a/modules/ROOT/pages/deployment/services/s-list/frontend.adoc b/modules/admin/pages/deployment/services/s-list/frontend.adoc similarity index 99% rename from modules/ROOT/pages/deployment/services/s-list/frontend.adoc rename to modules/admin/pages/deployment/services/s-list/frontend.adoc index e6ca4d60e..660f160f0 100644 --- a/modules/ROOT/pages/deployment/services/s-list/frontend.adoc +++ b/modules/admin/pages/deployment/services/s-list/frontend.adoc @@ -2,6 +2,7 @@ :toc: right :toclevels: 4 :description: The frontend service translates various ownCloud-related HTTP APIs to CS3 requests. +:page-aliases: ROOT:deployment/services/s-list/frontend.adoc :service_name: frontend diff --git a/modules/ROOT/pages/deployment/services/s-list/gateway.adoc b/modules/admin/pages/deployment/services/s-list/gateway.adoc similarity index 93% rename from modules/ROOT/pages/deployment/services/s-list/gateway.adoc rename to modules/admin/pages/deployment/services/s-list/gateway.adoc index 0966bfc93..ecb56ea46 100644 --- a/modules/ROOT/pages/deployment/services/s-list/gateway.adoc +++ b/modules/admin/pages/deployment/services/s-list/gateway.adoc @@ -1,6 +1,7 @@ = Gateway Service Configuration :toc: right :description: The Infinite Scale Gateway service is responsible for passing requests to the storage providers. +:page-aliases: ROOT:deployment/services/s-list/gateway.adoc :service_name: gateway diff --git a/modules/ROOT/pages/deployment/services/s-list/graph.adoc b/modules/admin/pages/deployment/services/s-list/graph.adoc similarity index 99% rename from modules/ROOT/pages/deployment/services/s-list/graph.adoc rename to modules/admin/pages/deployment/services/s-list/graph.adoc index 82ca1aa9f..8ab99c71b 100644 --- a/modules/ROOT/pages/deployment/services/s-list/graph.adoc +++ b/modules/admin/pages/deployment/services/s-list/graph.adoc @@ -1,6 +1,7 @@ = Graph Service Configuration :toc: right :description: The graph service provides the Graph API which is a RESTful web API used to access Infinite Scale resources. +:page-aliases: ROOT:deployment/services/s-list/graph.adoc :service_name: graph diff --git a/modules/ROOT/pages/deployment/services/s-list/groups.adoc b/modules/admin/pages/deployment/services/s-list/groups.adoc similarity index 86% rename from modules/ROOT/pages/deployment/services/s-list/groups.adoc rename to modules/admin/pages/deployment/services/s-list/groups.adoc index fcb2b170a..fcea43355 100644 --- a/modules/ROOT/pages/deployment/services/s-list/groups.adoc +++ b/modules/admin/pages/deployment/services/s-list/groups.adoc @@ -1,6 +1,7 @@ = Groups Service Configuration :toc: right :description: The Infinite Scale Group service +:page-aliases: ROOT:deployment/services/s-list/groups.adoc :service_name: groups diff --git a/modules/ROOT/pages/deployment/services/s-list/idm.adoc b/modules/admin/pages/deployment/services/s-list/idm.adoc similarity index 98% rename from modules/ROOT/pages/deployment/services/s-list/idm.adoc rename to modules/admin/pages/deployment/services/s-list/idm.adoc index 8c804324f..f83b97705 100644 --- a/modules/ROOT/pages/deployment/services/s-list/idm.adoc +++ b/modules/admin/pages/deployment/services/s-list/idm.adoc @@ -1,6 +1,7 @@ = IDM Service Configuration :toc: right :description: The Infinite Scale IDM service provides a minimal LDAP service for Infinite Scale. It is started as part of the runtime and serves as a central place for storing user and group information. +:page-aliases: ROOT:deployment/services/s-list/idm.adoc :service_name: idm diff --git a/modules/ROOT/pages/deployment/services/s-list/idp.adoc b/modules/admin/pages/deployment/services/s-list/idp.adoc similarity index 97% rename from modules/ROOT/pages/deployment/services/s-list/idp.adoc rename to modules/admin/pages/deployment/services/s-list/idp.adoc index 43ca0d4fe..695a888b9 100644 --- a/modules/ROOT/pages/deployment/services/s-list/idp.adoc +++ b/modules/admin/pages/deployment/services/s-list/idp.adoc @@ -1,6 +1,8 @@ = IDP Service Configuration :toc: right :description: The Infinite Scale IDP service provides a built-in minimal OpenID Connect provider. +:page-aliases: ROOT: +deployment/services/s-list/idp.adoc :service_name: idp diff --git a/modules/ROOT/pages/deployment/services/s-list/invitations.adoc b/modules/admin/pages/deployment/services/s-list/invitations.adoc similarity index 98% rename from modules/ROOT/pages/deployment/services/s-list/invitations.adoc rename to modules/admin/pages/deployment/services/s-list/invitations.adoc index 7302c508e..09f48e236 100644 --- a/modules/ROOT/pages/deployment/services/s-list/invitations.adoc +++ b/modules/admin/pages/deployment/services/s-list/invitations.adoc @@ -1,6 +1,7 @@ = Invitations Service Configuration :toc: right :description: The Infinite Scale invitations service provides an invitation manager that can be used to invite external users, aka guests, to an organization. +:page-aliases: ROOT:deployment/services/s-list/invitations.adoc :service_name: invitations diff --git a/modules/ROOT/pages/deployment/services/s-list/nats.adoc b/modules/admin/pages/deployment/services/s-list/nats.adoc similarity index 97% rename from modules/ROOT/pages/deployment/services/s-list/nats.adoc rename to modules/admin/pages/deployment/services/s-list/nats.adoc index 67972865e..e458369d8 100644 --- a/modules/ROOT/pages/deployment/services/s-list/nats.adoc +++ b/modules/admin/pages/deployment/services/s-list/nats.adoc @@ -1,6 +1,7 @@ = NATS Service Configuration :toc: right :description: The NATS service is the event broker of the system. It distributes events among all other services and enables other services to communicate asynchronously. +:page-aliases: ROOT:deployment/services/s-list/nats.adoc :service_name: nats diff --git a/modules/ROOT/pages/deployment/services/s-list/notifications.adoc b/modules/admin/pages/deployment/services/s-list/notifications.adoc similarity index 98% rename from modules/ROOT/pages/deployment/services/s-list/notifications.adoc rename to modules/admin/pages/deployment/services/s-list/notifications.adoc index f3a21cdf3..3c204d270 100644 --- a/modules/ROOT/pages/deployment/services/s-list/notifications.adoc +++ b/modules/admin/pages/deployment/services/s-list/notifications.adoc @@ -1,7 +1,9 @@ = Notifications Service Configuration :toc: right :description: The notification service is responsible for sending emails to users informing them about events that happened. -:github-master-url: https://github.com/owncloud/ocis/blob/master//services/notifications/pkg/email/templates +:page-aliases: ROOT:deployment/services/s-list/notifications.adoc + +:github-master-url: https://github.com/owncloud/ocis/blob/master/services/notifications/pkg/email/templates :service_name: notifications diff --git a/modules/ROOT/pages/deployment/services/s-list/ocdav.adoc b/modules/admin/pages/deployment/services/s-list/ocdav.adoc similarity index 97% rename from modules/ROOT/pages/deployment/services/s-list/ocdav.adoc rename to modules/admin/pages/deployment/services/s-list/ocdav.adoc index f05d829e7..ccb3e83c3 100644 --- a/modules/ROOT/pages/deployment/services/s-list/ocdav.adoc +++ b/modules/admin/pages/deployment/services/s-list/ocdav.adoc @@ -1,6 +1,7 @@ = OCDAV Service Configuration :toc: right :description: The ocDAV service is responsible for translating ownCloud-flavored WebDAV into CS3 API calls. Note that previews (thumbnails) are provided by the xref:{s-path}/webdav.adoc[WebDAV service]. +:page-aliases: ROOT:deployment/services/s-list/ocdav.adoc // references https://github.com/owncloud/ocis/pull/3864 ([docs-only] add PROPFIND sequence diagram examples) // also see: https://owncloud.dev/architecture/protocol-changes/ diff --git a/modules/ROOT/pages/deployment/services/s-list/ocm.adoc b/modules/admin/pages/deployment/services/s-list/ocm.adoc similarity index 98% rename from modules/ROOT/pages/deployment/services/s-list/ocm.adoc rename to modules/admin/pages/deployment/services/s-list/ocm.adoc index 4f31db845..51b3a7f83 100644 --- a/modules/ROOT/pages/deployment/services/s-list/ocm.adoc +++ b/modules/admin/pages/deployment/services/s-list/ocm.adoc @@ -2,6 +2,7 @@ :toc: right :ocm-api-version: 1.1.0 :description: The Infinite Scale OCM service provides federated sharing functionality based on ScienceMesh and the OCM {ocm-api-version} HTTP API. +:page-aliases: ROOT:deployment/services/s-list/ocm.adoc :site-object-url: https://developer.sciencemesh.io/docs/technical-documentation/central-database/#site-object :service_name: ocm diff --git a/modules/ROOT/pages/deployment/services/s-list/ocs.adoc b/modules/admin/pages/deployment/services/s-list/ocs.adoc similarity index 97% rename from modules/ROOT/pages/deployment/services/s-list/ocs.adoc rename to modules/admin/pages/deployment/services/s-list/ocs.adoc index d4ff01acb..e0ac99ee4 100644 --- a/modules/ROOT/pages/deployment/services/s-list/ocs.adoc +++ b/modules/admin/pages/deployment/services/s-list/ocs.adoc @@ -1,6 +1,7 @@ = OCS Service Configuration :toc: right :description: The Infinite Scale OCS service (open collaboration services) serves mainly one purpose: it has an endpoint for signing keys which the web frontend accesses when uploading data. +:page-aliases: ROOT:deployment/services/s-list/ocs.adoc :service_name: ocs diff --git a/modules/ROOT/pages/deployment/services/s-list/policies.adoc b/modules/admin/pages/deployment/services/s-list/policies.adoc similarity index 99% rename from modules/ROOT/pages/deployment/services/s-list/policies.adoc rename to modules/admin/pages/deployment/services/s-list/policies.adoc index c3a9276ef..5b836aa73 100644 --- a/modules/ROOT/pages/deployment/services/s-list/policies.adoc +++ b/modules/admin/pages/deployment/services/s-list/policies.adoc @@ -1,6 +1,7 @@ = Policies Service Configuration :toc: right :description: The Infinite Scale policies service provides a new gRPC API which can be used to check whether a requested operation is allowed or not. To do so, Open Policy Agent (OPA) is used to define the set of rules of what is permitted and what is not. +:page-aliases: ROOT:deployment/services/s-list/policies.adoc :service_name: policies diff --git a/modules/ROOT/pages/deployment/services/s-list/postprocessing.adoc b/modules/admin/pages/deployment/services/s-list/postprocessing.adoc similarity index 99% rename from modules/ROOT/pages/deployment/services/s-list/postprocessing.adoc rename to modules/admin/pages/deployment/services/s-list/postprocessing.adoc index 5085b3bbe..e62c14842 100644 --- a/modules/ROOT/pages/deployment/services/s-list/postprocessing.adoc +++ b/modules/admin/pages/deployment/services/s-list/postprocessing.adoc @@ -1,6 +1,7 @@ = Postprocessing Service Configuration :toc: right :description: The Infinite Scale postprocessing service handles the coordination of asynchronous post-processing steps. +:page-aliases: ROOT:deployment/services/s-list/postprocessing.adoc :service_name: postprocessing diff --git a/modules/ROOT/pages/deployment/services/s-list/proxy.adoc b/modules/admin/pages/deployment/services/s-list/proxy.adoc similarity index 99% rename from modules/ROOT/pages/deployment/services/s-list/proxy.adoc rename to modules/admin/pages/deployment/services/s-list/proxy.adoc index 80935273d..be0bea2a9 100644 --- a/modules/ROOT/pages/deployment/services/s-list/proxy.adoc +++ b/modules/admin/pages/deployment/services/s-list/proxy.adoc @@ -2,6 +2,7 @@ :toc: right :toclevels: 4 :description: The proxy service is an API-Gateway for the ownCloud Infinite Scale microservices. +:page-aliases: ROOT:deployment/services/s-list/proxy.adoc :service_name: proxy diff --git a/modules/ROOT/pages/deployment/services/s-list/search.adoc b/modules/admin/pages/deployment/services/s-list/search.adoc similarity index 99% rename from modules/ROOT/pages/deployment/services/s-list/search.adoc rename to modules/admin/pages/deployment/services/s-list/search.adoc index 370200f51..ff21bd355 100644 --- a/modules/ROOT/pages/deployment/services/s-list/search.adoc +++ b/modules/admin/pages/deployment/services/s-list/search.adoc @@ -1,6 +1,7 @@ = Search Service Configuration :toc: right :description: The Infinite Scale Search service is responsible for metadata and content extraction, stores that data as index and makes it searchable. +:page-aliases: ROOT:deployment/services/s-list/search.adoc :tika-version: 3.2.0 diff --git a/modules/ROOT/pages/deployment/services/s-list/services_rules.adoc b/modules/admin/pages/deployment/services/s-list/services_rules.adoc similarity index 100% rename from modules/ROOT/pages/deployment/services/s-list/services_rules.adoc rename to modules/admin/pages/deployment/services/s-list/services_rules.adoc diff --git a/modules/ROOT/pages/deployment/services/s-list/settings.adoc b/modules/admin/pages/deployment/services/s-list/settings.adoc similarity index 98% rename from modules/ROOT/pages/deployment/services/s-list/settings.adoc rename to modules/admin/pages/deployment/services/s-list/settings.adoc index 956328d85..6ae0b4365 100644 --- a/modules/ROOT/pages/deployment/services/s-list/settings.adoc +++ b/modules/admin/pages/deployment/services/s-list/settings.adoc @@ -1,6 +1,7 @@ = Settings Service Configuration :toc: right :description: The Infinite Scale Settings service provides functionality for other services to register new settings as well as storing and retrieving the respective settings' values. +:page-aliases: ROOT:deployment/services/s-list/settings.adoc :service_name: settings diff --git a/modules/ROOT/pages/deployment/services/s-list/sharing.adoc b/modules/admin/pages/deployment/services/s-list/sharing.adoc similarity index 90% rename from modules/ROOT/pages/deployment/services/s-list/sharing.adoc rename to modules/admin/pages/deployment/services/s-list/sharing.adoc index 91d1a8fa5..73dc8b096 100644 --- a/modules/ROOT/pages/deployment/services/s-list/sharing.adoc +++ b/modules/admin/pages/deployment/services/s-list/sharing.adoc @@ -1,6 +1,7 @@ = Sharing Service Configuration :toc: right :description: The Infinite Scale Sharing service +:page-aliases: ROOT:deployment/services/s-list/sharing.adoc :service_name: sharing diff --git a/modules/ROOT/pages/deployment/services/s-list/sse.adoc b/modules/admin/pages/deployment/services/s-list/sse.adoc similarity index 96% rename from modules/ROOT/pages/deployment/services/s-list/sse.adoc rename to modules/admin/pages/deployment/services/s-list/sse.adoc index f06f24f6a..54fd04689 100644 --- a/modules/ROOT/pages/deployment/services/s-list/sse.adoc +++ b/modules/admin/pages/deployment/services/s-list/sse.adoc @@ -1,6 +1,7 @@ = SSE (Server-Sent Events) Configuration :toc: right :description: The Infinite Scale sse service is responsible for sending sse (server-sent events) to a user. +:page-aliases: ROOT:deployment/services/s-list/sse.adoc :service_name: sse diff --git a/modules/ROOT/pages/deployment/services/s-list/storage-publiclink.adoc b/modules/admin/pages/deployment/services/s-list/storage-publiclink.adoc similarity index 96% rename from modules/ROOT/pages/deployment/services/s-list/storage-publiclink.adoc rename to modules/admin/pages/deployment/services/s-list/storage-publiclink.adoc index a231ff39b..f9f82bbc9 100644 --- a/modules/ROOT/pages/deployment/services/s-list/storage-publiclink.adoc +++ b/modules/admin/pages/deployment/services/s-list/storage-publiclink.adoc @@ -1,6 +1,7 @@ = Storage-Publiclink Service Configuration :toc: right :description: The Infinite Scale Storage-Publiclink service +:page-aliases: ROOT:deployment/services/s-list/storage-publiclink.adoc :service_name: storage-publiclink diff --git a/modules/ROOT/pages/deployment/services/s-list/storage-shares.adoc b/modules/admin/pages/deployment/services/s-list/storage-shares.adoc similarity index 86% rename from modules/ROOT/pages/deployment/services/s-list/storage-shares.adoc rename to modules/admin/pages/deployment/services/s-list/storage-shares.adoc index 000f6d3ac..35e7e8308 100644 --- a/modules/ROOT/pages/deployment/services/s-list/storage-shares.adoc +++ b/modules/admin/pages/deployment/services/s-list/storage-shares.adoc @@ -1,6 +1,7 @@ = Storage-Shares Service Configuration :toc: right :description: The Infinite Scale Storage-Shares service +:page-aliases: ROOT:deployment/services/s-list/storage-shares.adoc :service_name: storage-shares diff --git a/modules/ROOT/pages/deployment/services/s-list/storage-system.adoc b/modules/admin/pages/deployment/services/s-list/storage-system.adoc similarity index 92% rename from modules/ROOT/pages/deployment/services/s-list/storage-system.adoc rename to modules/admin/pages/deployment/services/s-list/storage-system.adoc index 72ae707d1..37297d3c5 100644 --- a/modules/ROOT/pages/deployment/services/s-list/storage-system.adoc +++ b/modules/admin/pages/deployment/services/s-list/storage-system.adoc @@ -1,6 +1,7 @@ = Storage-System Service Configuration :toc: right :description: The Infinite Scale Storage-System service persists and caches user related data that is defined via Infinite Scale. +:page-aliases: ROOT:deployment/services/s-list/storage-system.adoc :service_name: storage-system diff --git a/modules/ROOT/pages/deployment/services/s-list/storage-users.adoc b/modules/admin/pages/deployment/services/s-list/storage-users.adoc similarity index 99% rename from modules/ROOT/pages/deployment/services/s-list/storage-users.adoc rename to modules/admin/pages/deployment/services/s-list/storage-users.adoc index 351bed824..a566526e1 100644 --- a/modules/ROOT/pages/deployment/services/s-list/storage-users.adoc +++ b/modules/admin/pages/deployment/services/s-list/storage-users.adoc @@ -1,10 +1,11 @@ = Storage-Users Service Configuration :toc: right :toclevels: 3 -:tus-url: https://tus.io :description: The Infinite Scale Storage-Users service +:page-aliases: ROOT:deployment/services/s-list/storage-users.adoc :service_name: storage-users +:tus-url: https://tus.io == Introduction diff --git a/modules/ROOT/pages/deployment/services/s-list/store.adoc b/modules/admin/pages/deployment/services/s-list/store.adoc similarity index 90% rename from modules/ROOT/pages/deployment/services/s-list/store.adoc rename to modules/admin/pages/deployment/services/s-list/store.adoc index 761d3a8ab..5e782ae09 100644 --- a/modules/ROOT/pages/deployment/services/s-list/store.adoc +++ b/modules/admin/pages/deployment/services/s-list/store.adoc @@ -1,6 +1,7 @@ = Store Service Configuration :toc: right :description: The Infinite Scale Store service +:page-aliases: ROOT:deployment/services/s-list/store.adoc :service_name: store diff --git a/modules/ROOT/pages/deployment/services/s-list/thumbnails.adoc b/modules/admin/pages/deployment/services/s-list/thumbnails.adoc similarity index 98% rename from modules/ROOT/pages/deployment/services/s-list/thumbnails.adoc rename to modules/admin/pages/deployment/services/s-list/thumbnails.adoc index 28e5c70f0..7df0597a1 100644 --- a/modules/ROOT/pages/deployment/services/s-list/thumbnails.adoc +++ b/modules/admin/pages/deployment/services/s-list/thumbnails.adoc @@ -1,6 +1,7 @@ = Thumbnails Service Configuration :toc: right :description: The thumbnails service provides methods to generate thumbnails for various files and resolutions based on requests, +:page-aliases: ROOT:deployment/services/s-list/thumbnails.adoc :service_name: thumbnails diff --git a/modules/ROOT/pages/deployment/services/s-list/userlog.adoc b/modules/admin/pages/deployment/services/s-list/userlog.adoc similarity index 98% rename from modules/ROOT/pages/deployment/services/s-list/userlog.adoc rename to modules/admin/pages/deployment/services/s-list/userlog.adoc index f7240146f..bc529b7fd 100644 --- a/modules/ROOT/pages/deployment/services/s-list/userlog.adoc +++ b/modules/admin/pages/deployment/services/s-list/userlog.adoc @@ -1,6 +1,7 @@ = Userlog Service Configuration :toc: right :description: The Infinite Scale userlog service is a mediator between the eventhistory service and clients who want to be informed about user-related events. It provides an API to retrieve those. +:page-aliases: ROOT:deployment/services/s-list/userlog.adoc :oc10-api-url: https://doc.owncloud.com/server/next/developer_manual/core/apis/ocs-notification-endpoint-v1.html#get-user-notifications diff --git a/modules/ROOT/pages/deployment/services/s-list/users.adoc b/modules/admin/pages/deployment/services/s-list/users.adoc similarity index 86% rename from modules/ROOT/pages/deployment/services/s-list/users.adoc rename to modules/admin/pages/deployment/services/s-list/users.adoc index e2d643662..e04ce661f 100644 --- a/modules/ROOT/pages/deployment/services/s-list/users.adoc +++ b/modules/admin/pages/deployment/services/s-list/users.adoc @@ -1,6 +1,7 @@ = Users Service Configuration :toc: right :description: The Infinite Scale User service +:page-aliases: ROOT:deployment/services/s-list/users.adoc :service_name: users diff --git a/modules/ROOT/pages/deployment/services/s-list/web.adoc b/modules/admin/pages/deployment/services/s-list/web.adoc similarity index 97% rename from modules/ROOT/pages/deployment/services/s-list/web.adoc rename to modules/admin/pages/deployment/services/s-list/web.adoc index dbafd1692..50d8dc745 100644 --- a/modules/ROOT/pages/deployment/services/s-list/web.adoc +++ b/modules/admin/pages/deployment/services/s-list/web.adoc @@ -1,6 +1,7 @@ = Web Service Configuration :toc: right :description: The web service embeds and serves the static files for the Infinite Scale web client. +:page-aliases: ROOT:deployment/services/s-list/web.adoc :service_name: web diff --git a/modules/ROOT/pages/deployment/services/s-list/webdav.adoc b/modules/admin/pages/deployment/services/s-list/webdav.adoc similarity index 96% rename from modules/ROOT/pages/deployment/services/s-list/webdav.adoc rename to modules/admin/pages/deployment/services/s-list/webdav.adoc index 8388a3ec1..f9524d9dd 100644 --- a/modules/ROOT/pages/deployment/services/s-list/webdav.adoc +++ b/modules/admin/pages/deployment/services/s-list/webdav.adoc @@ -1,6 +1,7 @@ = WebDAV Service Configuration :toc: right :description: The WebDAV service, like the ocdav service, provides a HTTP API following the WebDAV protocol. +:page-aliases: ROOT:deployment/services/s-list/webdav.adoc :service_name: webdav diff --git a/modules/ROOT/pages/deployment/services/s-list/webfinger.adoc b/modules/admin/pages/deployment/services/s-list/webfinger.adoc similarity index 98% rename from modules/ROOT/pages/deployment/services/s-list/webfinger.adoc rename to modules/admin/pages/deployment/services/s-list/webfinger.adoc index b3c5f631f..a721de87c 100644 --- a/modules/ROOT/pages/deployment/services/s-list/webfinger.adoc +++ b/modules/admin/pages/deployment/services/s-list/webfinger.adoc @@ -1,6 +1,8 @@ = Webfinger Service Configuration :toc: right :description: The Infinite Scale webfinger service provides an RFC7033 WebFinger lookup of ownCloud instances relevant for a given user account. +:page-aliases: ROOT:deployment/services/s-list/webfinger.adoc + :webfinger-url: https://en.wikipedia.org/wiki/WebFinger :service_name: webfinger diff --git a/modules/ROOT/pages/deployment/services/services.adoc b/modules/admin/pages/deployment/services/services.adoc similarity index 99% rename from modules/ROOT/pages/deployment/services/services.adoc rename to modules/admin/pages/deployment/services/services.adoc index 802a69c5e..ea212525c 100644 --- a/modules/ROOT/pages/deployment/services/services.adoc +++ b/modules/admin/pages/deployment/services/services.adoc @@ -1,6 +1,7 @@ = Services :toc: right :description: The Infinite Scale platform consists of microservices interconnecting with each other. Each service performs a particular task and can be configured independently. +:page-aliases: ROOT:deployment/services/services.adoc == Introduction diff --git a/modules/ROOT/pages/deployment/services/tls.adoc b/modules/admin/pages/deployment/services/tls.adoc similarity index 99% rename from modules/ROOT/pages/deployment/services/tls.adoc rename to modules/admin/pages/deployment/services/tls.adoc index 0e4d15fb4..d392df18e 100644 --- a/modules/ROOT/pages/deployment/services/tls.adoc +++ b/modules/admin/pages/deployment/services/tls.adoc @@ -1,6 +1,7 @@ = Transport Layer Security (TLS) :toc: right :description: TLS is important to secure communication between parties. Infinite Scale provides TLS for internal communication and also for communication with users or services which are not provided by Infinite Scale. +:page-aliases: ROOT:deployment/services/tls.adoc == Introduction diff --git a/modules/ROOT/pages/deployment/storage/general-considerations.adoc b/modules/admin/pages/deployment/storage/general-considerations.adoc similarity index 99% rename from modules/ROOT/pages/deployment/storage/general-considerations.adoc rename to modules/admin/pages/deployment/storage/general-considerations.adoc index 8b1c3c005..e3928e21d 100644 --- a/modules/ROOT/pages/deployment/storage/general-considerations.adoc +++ b/modules/admin/pages/deployment/storage/general-considerations.adoc @@ -2,6 +2,7 @@ :toc: right :toclevels: 2 :description: Infinite Scale can connect to several types of storages. This document gives some general information, considerations and recommendations with regards to supported storages. +:page-aliases: ROOT:deployment/storage/general-considerations.adoc == Introduction diff --git a/modules/ROOT/pages/deployment/storage/nfs.adoc b/modules/admin/pages/deployment/storage/nfs.adoc similarity index 99% rename from modules/ROOT/pages/deployment/storage/nfs.adoc rename to modules/admin/pages/deployment/storage/nfs.adoc index 15c01a723..d57c2cf64 100644 --- a/modules/ROOT/pages/deployment/storage/nfs.adoc +++ b/modules/admin/pages/deployment/storage/nfs.adoc @@ -3,6 +3,7 @@ :toclevels: 2 :page-aliases: deployment/nfs/nfs.adoc :description: ownCloud recommends using NFS for any scenario when accessing Unix-based remote servers or storages other than local storage. It has solid performance and is very stable. This guide covers the official ownCloud NFS (Network File System) deployment recommendations for Infinite Scale. +:page-aliases: ROOT:deployment/storage/nfs.adoc :ea-ietf-url: https://datatracker.ietf.org/doc/html/rfc8276 :autofs-url: https://help.ubuntu.com/community/Autofs diff --git a/modules/ROOT/pages/deployment/storage/posixfs.adoc b/modules/admin/pages/deployment/storage/posixfs.adoc similarity index 99% rename from modules/ROOT/pages/deployment/storage/posixfs.adoc rename to modules/admin/pages/deployment/storage/posixfs.adoc index 88697c92a..a1fc5a3f9 100644 --- a/modules/ROOT/pages/deployment/storage/posixfs.adoc +++ b/modules/admin/pages/deployment/storage/posixfs.adoc @@ -2,6 +2,7 @@ :toc: right :toclevels: 2 :description: Infinite Scale can store metadata and files on posix based filesystems with shared access. This document gives some general information and considerations for the use of PosixFS. +:page-aliases: ROOT:deployment/storage/posixfs.adoc == Introduction diff --git a/modules/ROOT/pages/deployment/storage/s3.adoc b/modules/admin/pages/deployment/storage/s3.adoc similarity index 99% rename from modules/ROOT/pages/deployment/storage/s3.adoc rename to modules/admin/pages/deployment/storage/s3.adoc index f979228ee..1249879eb 100644 --- a/modules/ROOT/pages/deployment/storage/s3.adoc +++ b/modules/admin/pages/deployment/storage/s3.adoc @@ -2,6 +2,7 @@ :toc: right :toclevels: 2 :description: Infinite Scale can store blobs on S3 storage. This document gives some general information and considerations for the use of S3. +:page-aliases: ROOT:deployment/storage/s3.adoc :aws-bucket-policy-url: https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucket-policies.html diff --git a/modules/ROOT/pages/deployment/tips/useful_mount_tip.adoc b/modules/admin/pages/deployment/tips/useful_mount_tip.adoc similarity index 100% rename from modules/ROOT/pages/deployment/tips/useful_mount_tip.adoc rename to modules/admin/pages/deployment/tips/useful_mount_tip.adoc diff --git a/modules/ROOT/pages/deployment/webui/webui-customisation.adoc b/modules/admin/pages/deployment/webui/webui-customisation.adoc similarity index 98% rename from modules/ROOT/pages/deployment/webui/webui-customisation.adoc rename to modules/admin/pages/deployment/webui/webui-customisation.adoc index c98e6e4b6..160c6f0d3 100644 --- a/modules/ROOT/pages/deployment/webui/webui-customisation.adoc +++ b/modules/admin/pages/deployment/webui/webui-customisation.adoc @@ -1,7 +1,7 @@ = ownCloud Web with Custom Configuration :toc: right -:page-aliases: deployment/webui/webui.adoc :description: The behavior of the embedded web frontend named ownCloud Web can be configured. This guide shows you how to do so. +:page-aliases: ROOT:deployment/webui/webui-customisation.adoc, ROOT:deployment/webui/webui.adoc == Introduction diff --git a/modules/ROOT/pages/deployment/webui/webui-theming.adoc b/modules/admin/pages/deployment/webui/webui-theming.adoc similarity index 98% rename from modules/ROOT/pages/deployment/webui/webui-theming.adoc rename to modules/admin/pages/deployment/webui/webui-theming.adoc index 0786c7e0e..f21c9b7f2 100644 --- a/modules/ROOT/pages/deployment/webui/webui-theming.adoc +++ b/modules/admin/pages/deployment/webui/webui-theming.adoc @@ -2,6 +2,7 @@ :toc: right :toclevels: 2 :description: Just like with other clients (Desktop, Android, iOS), themes can be used with ownCloud Web. +:page-aliases: ROOT:deployment/webui/webui-theming.adoc :web_assets_path: /services/web/assets/themes/owncloud/ :example-theme-url: https://github.com/owncloud/web/tree/master/config diff --git a/modules/ROOT/pages/deployment/wopi/wopi.adoc b/modules/admin/pages/deployment/wopi/wopi.adoc similarity index 99% rename from modules/ROOT/pages/deployment/wopi/wopi.adoc rename to modules/admin/pages/deployment/wopi/wopi.adoc index 45e405e23..db2fe47e8 100644 --- a/modules/ROOT/pages/deployment/wopi/wopi.adoc +++ b/modules/admin/pages/deployment/wopi/wopi.adoc @@ -1,6 +1,7 @@ = Office Applications Using WOPI :toc: right :description: Infinite Scale uses the WOPI protocol to integrate office applications. This document describes the general flow and basic settings used. +:page-aliases: ROOT:deployment/wopi/wopi.adoc :office-online-server-url: https://docs.microsoft.com/de-de/officeonlineserver/deploy-office-online-server :office365-url: https://products.office.com/en-us/business/office diff --git a/modules/admin/pages/index.adoc b/modules/admin/pages/index.adoc new file mode 100644 index 000000000..4c5309c5e --- /dev/null +++ b/modules/admin/pages/index.adoc @@ -0,0 +1,74 @@ += Infinite Scale Admin Documentation +:toc: right +:toclevels: 2 +:description: Welcome to the Infinite Scale admin documentation. Infinite Scale is a data platform providing tools to integrate, organize, share and govern data and metadata. This guide provides information on general topics, on installation and administrative tasks for Infinite Scale. + +:github-url: https://github.com/owncloud/docs-ocis/issues + +:ocis_youtube_long_url: https://www.youtube.com/watch?v=C4a4q9IGyFQ&list=PLXpTv1ixYy3-b5LScHyYqMNwEsZYgejdX&index=16 +:ocis_youtube_short_url: C4a4q9IGyFQ + +include::admin:partial$multi-location/compose-version.adoc[] + +== Introduction + +{description} + +// IMPORTANT: this permalink origins to: https://cloud.owncloud.com/index.php/apps/files/?dir=/Shared/owncloud/Product%20Management/Presentations/2023-05-22_Infinite%20Scale%20current%20state&fileid=6005441 + +=== Target Audience + +This documentation addresses administrators and technically-oriented management: + +* people responsible that services are up and running for users, +* people responsible that the IT infrastructure is in line with the organization's compliance regulations, +* technical advisors and technical buyers. + +=== Infinite Scale Key Benefits + +The Infinite Scale data platform is designed for multi-storage access, is cloud-native (microservices) and provides unified data access. + +The key benefits are:: + +* Integration of distributed data sources into one cloud data ecosystem. +* A unified data access layer across all data. +* Combination of on-premises and cloud-operated environments into one user experience. +* No need for PHP or a database. +* High performance, flexibility and scalability. +* Extended functionality. +* Container delivery, shipped with the user interface `ownCloud Web`. + +See the following in-line YouTube video for more details or use the link:{ocis_youtube_long_url}[link, window=_blank] to view it in a separate browser tab. + +.Infinite Scale - A new era for ownCloud - ownCloud Conference 2021 +video::{ocis_youtube_short_url}[youtube] + +== Brief Overview + +NOTE: In configuration variables and comments, you'll often come across the word oCIS or ocis, short for "ownCloud Infinite Scale", while the product is simply called Infinite Scale. + +=== Architecture and Concepts + +To learn more about Infinite Scale, check out the xref:admin:architecture/architecture.adoc[Architecture and Concepts] section first. This information may help deciding which environment is optimal for your use case and which hardware fits your needs best. + +=== Availability and Scalability + +With knowledge about architecture and concepts, look at the different xref:admin:availability_scaling/availability_scaling.adoc[Availability and Scalability] options to define the environment Infinite Scale should run on. + +=== Prerequisites + +With Infinite Scale, not much is needed to run your ownCloud server the way you want. Check out the details in the xref:admin:prerequisites/prerequisites.adoc[Prerequisites] section. We strongly recommend to make up your mind about availability and scalability first. + +=== Deployment + +Infinite Scale is deployed via container. Take a look at the Deployment Examples section in the navigation for more details. + +NOTE: We highly recommend reading the xref:admin:deployment/general/general-info.adoc[General Info] document first before starting to plan or deploy Infinite Scale. This document contains important topics relevant for all deployments. + +=== Configuration Examples + +Configuration of Infinite Scale might be quite different to what you are used to but it's very simple. It works with environment variables and optional configuration files for you to create depending on your specific needs. The settings in configuration files can always be overruled by setting the respective environment variables manually on the command line. + +== End-User License Agreement (EULA) + +ownCloud provides an EULA to clarify, among various topics, who can use this software and which conditions apply to the groups of users defined. See the actual {compose_raw_url}{compose_version}/assets/End-User-License-Agreement-for-ownCloud-Infinite-Scale.pdf[EULA] for details. diff --git a/modules/ROOT/pages/maintenance/b-r/backup.adoc b/modules/admin/pages/maintenance/b-r/backup.adoc similarity index 98% rename from modules/ROOT/pages/maintenance/b-r/backup.adoc rename to modules/admin/pages/maintenance/b-r/backup.adoc index 7ac5757b5..110a61bd3 100644 --- a/modules/ROOT/pages/maintenance/b-r/backup.adoc +++ b/modules/admin/pages/maintenance/b-r/backup.adoc @@ -1,6 +1,7 @@ = Backup :toc: right :description: Making a backup of the Infinite Scale instance is an important task that should be done on a regular basis. +:page-aliases: ROOT:maintenance/b-r/backup.adoc == Introduction diff --git a/modules/ROOT/pages/maintenance/b-r/backup_considerations.adoc b/modules/admin/pages/maintenance/b-r/backup_considerations.adoc similarity index 99% rename from modules/ROOT/pages/maintenance/b-r/backup_considerations.adoc rename to modules/admin/pages/maintenance/b-r/backup_considerations.adoc index 04b3fd186..698643c55 100644 --- a/modules/ROOT/pages/maintenance/b-r/backup_considerations.adoc +++ b/modules/admin/pages/maintenance/b-r/backup_considerations.adoc @@ -1,6 +1,7 @@ = Backup Considerations :toc: right :description: To optimize your backups, this small guide aims to shed some light on the internal Infinite Scale data structure. +:page-aliases: ROOT:maintenance/b-r/backup_considerations.adoc == Introduction diff --git a/modules/ROOT/pages/maintenance/b-r/restore.adoc b/modules/admin/pages/maintenance/b-r/restore.adoc similarity index 98% rename from modules/ROOT/pages/maintenance/b-r/restore.adoc rename to modules/admin/pages/maintenance/b-r/restore.adoc index dd0e7d551..76094e336 100644 --- a/modules/ROOT/pages/maintenance/b-r/restore.adoc +++ b/modules/admin/pages/maintenance/b-r/restore.adoc @@ -1,6 +1,7 @@ = Restore :toc: right :description: Restoring from an Infinite Scale backup can be a task bringing the instance back to production after a major incident occurs. +:page-aliases: ROOT:maintenance/b-r/restore.adoc == Introduction diff --git a/modules/ROOT/pages/maintenance/commands/backup-consistency.adoc b/modules/admin/pages/maintenance/commands/backup-consistency.adoc similarity index 100% rename from modules/ROOT/pages/maintenance/commands/backup-consistency.adoc rename to modules/admin/pages/maintenance/commands/backup-consistency.adoc diff --git a/modules/ROOT/pages/maintenance/commands/changed-cli.adoc b/modules/admin/pages/maintenance/commands/changed-cli.adoc similarity index 100% rename from modules/ROOT/pages/maintenance/commands/changed-cli.adoc rename to modules/admin/pages/maintenance/commands/changed-cli.adoc diff --git a/modules/ROOT/pages/maintenance/commands/cleanup-orphaned-grants.adoc b/modules/admin/pages/maintenance/commands/cleanup-orphaned-grants.adoc similarity index 100% rename from modules/ROOT/pages/maintenance/commands/cleanup-orphaned-grants.adoc rename to modules/admin/pages/maintenance/commands/cleanup-orphaned-grants.adoc diff --git a/modules/ROOT/pages/maintenance/commands/cleanup-orphaned-shares.adoc b/modules/admin/pages/maintenance/commands/cleanup-orphaned-shares.adoc similarity index 100% rename from modules/ROOT/pages/maintenance/commands/cleanup-orphaned-shares.adoc rename to modules/admin/pages/maintenance/commands/cleanup-orphaned-shares.adoc diff --git a/modules/ROOT/pages/maintenance/commands/commands.adoc b/modules/admin/pages/maintenance/commands/commands.adoc similarity index 99% rename from modules/ROOT/pages/maintenance/commands/commands.adoc rename to modules/admin/pages/maintenance/commands/commands.adoc index 590050363..9828e3d2d 100644 --- a/modules/ROOT/pages/maintenance/commands/commands.adoc +++ b/modules/admin/pages/maintenance/commands/commands.adoc @@ -1,6 +1,7 @@ = Maintenance Commands :toc: right :description: There are commands availabe to maintain the Infinite Scale instance. This document gives an overview of the available commands and links to the related services where they are implemented for more details. +:page-aliases: ROOT:maintenance/commands/commands.adoc == Introduction diff --git a/modules/ROOT/pages/maintenance/commands/move-stuck-uploads.adoc b/modules/admin/pages/maintenance/commands/move-stuck-uploads.adoc similarity index 100% rename from modules/ROOT/pages/maintenance/commands/move-stuck-uploads.adoc rename to modules/admin/pages/maintenance/commands/move-stuck-uploads.adoc diff --git a/modules/ROOT/pages/maintenance/commands/node-metadata.adoc b/modules/admin/pages/maintenance/commands/node-metadata.adoc similarity index 100% rename from modules/ROOT/pages/maintenance/commands/node-metadata.adoc rename to modules/admin/pages/maintenance/commands/node-metadata.adoc diff --git a/modules/ROOT/pages/maintenance/commands/node-tree-size.adoc b/modules/admin/pages/maintenance/commands/node-tree-size.adoc similarity index 100% rename from modules/ROOT/pages/maintenance/commands/node-tree-size.adoc rename to modules/admin/pages/maintenance/commands/node-tree-size.adoc diff --git a/modules/ROOT/pages/maintenance/commands/rebuild-jsoncs3-indexes.adoc b/modules/admin/pages/maintenance/commands/rebuild-jsoncs3-indexes.adoc similarity index 100% rename from modules/ROOT/pages/maintenance/commands/rebuild-jsoncs3-indexes.adoc rename to modules/admin/pages/maintenance/commands/rebuild-jsoncs3-indexes.adoc diff --git a/modules/ROOT/pages/maintenance/commands/revisions-cleanup.adoc b/modules/admin/pages/maintenance/commands/revisions-cleanup.adoc similarity index 100% rename from modules/ROOT/pages/maintenance/commands/revisions-cleanup.adoc rename to modules/admin/pages/maintenance/commands/revisions-cleanup.adoc diff --git a/modules/ROOT/pages/maintenance/commands/rolling-back-and-forward.adoc b/modules/admin/pages/maintenance/commands/rolling-back-and-forward.adoc similarity index 100% rename from modules/ROOT/pages/maintenance/commands/rolling-back-and-forward.adoc rename to modules/admin/pages/maintenance/commands/rolling-back-and-forward.adoc diff --git a/modules/ROOT/pages/maintenance/commands/service-health.adoc b/modules/admin/pages/maintenance/commands/service-health.adoc similarity index 100% rename from modules/ROOT/pages/maintenance/commands/service-health.adoc rename to modules/admin/pages/maintenance/commands/service-health.adoc diff --git a/modules/ROOT/pages/maintenance/commands/trash.adoc b/modules/admin/pages/maintenance/commands/trash.adoc similarity index 100% rename from modules/ROOT/pages/maintenance/commands/trash.adoc rename to modules/admin/pages/maintenance/commands/trash.adoc diff --git a/modules/ROOT/pages/maintenance/m-mode/maintenance-mode.adoc b/modules/admin/pages/maintenance/m-mode/maintenance-mode.adoc similarity index 98% rename from modules/ROOT/pages/maintenance/m-mode/maintenance-mode.adoc rename to modules/admin/pages/maintenance/m-mode/maintenance-mode.adoc index 441a0a5ab..0fcbc07ad 100644 --- a/modules/ROOT/pages/maintenance/m-mode/maintenance-mode.adoc +++ b/modules/admin/pages/maintenance/m-mode/maintenance-mode.adoc @@ -1,6 +1,7 @@ = Maintenance Mode :toc: right :description: There are a few things to consider when updating/upgrading Infinite Scale. +:page-aliases: ROOT:maintenance/m-mode/maintenance-mode.adoc == Introduction diff --git a/modules/ROOT/pages/maintenance/space-ids/space-ids.adoc b/modules/admin/pages/maintenance/space-ids/space-ids.adoc similarity index 98% rename from modules/ROOT/pages/maintenance/space-ids/space-ids.adoc rename to modules/admin/pages/maintenance/space-ids/space-ids.adoc index 5bff66603..a73e45dd7 100644 --- a/modules/ROOT/pages/maintenance/space-ids/space-ids.adoc +++ b/modules/admin/pages/maintenance/space-ids/space-ids.adoc @@ -1,6 +1,7 @@ = Listing Space IDs :toc: right :description: There are rare situations like when using shell commands that require the space ID as parameter. This page shows how to get it. +:page-aliases: ROOT:maintenance/space-ids/space-ids.adoc == Introduction diff --git a/modules/ROOT/pages/maintenance/user-ids/user-ids.adoc b/modules/admin/pages/maintenance/user-ids/user-ids.adoc similarity index 97% rename from modules/ROOT/pages/maintenance/user-ids/user-ids.adoc rename to modules/admin/pages/maintenance/user-ids/user-ids.adoc index 1ff6a34f5..da38ac6c3 100644 --- a/modules/ROOT/pages/maintenance/user-ids/user-ids.adoc +++ b/modules/admin/pages/maintenance/user-ids/user-ids.adoc @@ -1,6 +1,7 @@ = Listing User IDs :toc: right :description: There are rare situations like when using shell commands that require the user ID as parameter. This page shows how to get it. +:page-aliases: ROOT:maintenance/user-ids/user-ids.adoc == Introduction diff --git a/modules/ROOT/pages/migration/upgrading-ocis.adoc b/modules/admin/pages/migration/upgrading-ocis.adoc similarity index 99% rename from modules/ROOT/pages/migration/upgrading-ocis.adoc rename to modules/admin/pages/migration/upgrading-ocis.adoc index cdec5f37a..aca75c97c 100644 --- a/modules/ROOT/pages/migration/upgrading-ocis.adoc +++ b/modules/admin/pages/migration/upgrading-ocis.adoc @@ -2,6 +2,7 @@ :toc: right :toclevels: 2 :description: When upgrading Infinite Scale, migration steps may be required. This document guides you through the necessary steps based on the versions used. +:page-aliases: ROOT:migration/upgrading-ocis.adoc include::partial$multi-location/compose-version.adoc[] diff --git a/modules/ROOT/pages/migration/upgrading_2.0.0_3.0.0.adoc b/modules/admin/pages/migration/upgrading_2.0.0_3.0.0.adoc similarity index 100% rename from modules/ROOT/pages/migration/upgrading_2.0.0_3.0.0.adoc rename to modules/admin/pages/migration/upgrading_2.0.0_3.0.0.adoc diff --git a/modules/ROOT/pages/migration/upgrading_3.0.0_4.0.0.adoc b/modules/admin/pages/migration/upgrading_3.0.0_4.0.0.adoc similarity index 100% rename from modules/ROOT/pages/migration/upgrading_3.0.0_4.0.0.adoc rename to modules/admin/pages/migration/upgrading_3.0.0_4.0.0.adoc diff --git a/modules/ROOT/pages/migration/upgrading_4.0.0_5.0.0.adoc b/modules/admin/pages/migration/upgrading_4.0.0_5.0.0.adoc similarity index 100% rename from modules/ROOT/pages/migration/upgrading_4.0.0_5.0.0.adoc rename to modules/admin/pages/migration/upgrading_4.0.0_5.0.0.adoc diff --git a/modules/ROOT/pages/migration/upgrading_5.0.x_7.0.0.adoc b/modules/admin/pages/migration/upgrading_5.0.x_7.0.0.adoc similarity index 94% rename from modules/ROOT/pages/migration/upgrading_5.0.x_7.0.0.adoc rename to modules/admin/pages/migration/upgrading_5.0.x_7.0.0.adoc index a4e3de40c..5fc5f7832 100644 --- a/modules/ROOT/pages/migration/upgrading_5.0.x_7.0.0.adoc +++ b/modules/admin/pages/migration/upgrading_5.0.x_7.0.0.adoc @@ -32,7 +32,9 @@ Download and install Infinite Scale via: === Binary -Follow the xref:depl-examples/minimal-bare-metal.adoc#installation[Installation] section of the bare metal deployment example. +// outdated link, page-alias does not work +// Follow the xref:depl-examples/minimal-bare-metal.adoc#installation[Installation] section of the bare metal deployment example. +Follow the xref:depl-examples/ubuntu-compose/ubuntu-compose-prod.adoc#installation[Installation] section of the bare metal deployment example. === Image Based Deployments @@ -48,7 +50,9 @@ docker pull owncloud/ocis:{actual_seven_version} Depending how you deployed Infinite Scale, you need to shut it down differently. * *Binary* + -For binary deployments, do a graceful shutdown as described in xref:depl-examples/minimal-bare-metal.adoc#stopping-infinite-scale[Stopping Infinite Scale]. +For binary deployments, do a graceful shutdown as described in xref:depl-examples/ubuntu-compose/ubuntu-compose-prod.adoc#stopping-infinite-scale[Stopping Infinite Scale]. +// outdated link, page-alias does not work +// For binary deployments, do a graceful shutdown as described in xref:depl-examples/minimal-bare-metal.adoc#stopping-infinite-scale[Stopping Infinite Scale]. * *docker compose* + For deployments using `docker compose` do a graceful shutdown as described in xref:depl-examples/ubuntu-compose/ubuntu-compose-prod.adoc#stop-the-deployment[Stop the Deployment]. diff --git a/modules/ROOT/pages/migration/upgrading_7.0.0_7.1.0.adoc b/modules/admin/pages/migration/upgrading_7.0.0_7.1.0.adoc similarity index 100% rename from modules/ROOT/pages/migration/upgrading_7.0.0_7.1.0.adoc rename to modules/admin/pages/migration/upgrading_7.0.0_7.1.0.adoc diff --git a/modules/ROOT/pages/migration/upgrading_7.1.0_7.2.0.adoc b/modules/admin/pages/migration/upgrading_7.1.0_7.2.0.adoc similarity index 100% rename from modules/ROOT/pages/migration/upgrading_7.1.0_7.2.0.adoc rename to modules/admin/pages/migration/upgrading_7.1.0_7.2.0.adoc diff --git a/modules/ROOT/pages/migration/upgrading_7.2.0_7.3.0.adoc b/modules/admin/pages/migration/upgrading_7.2.0_7.3.0.adoc similarity index 100% rename from modules/ROOT/pages/migration/upgrading_7.2.0_7.3.0.adoc rename to modules/admin/pages/migration/upgrading_7.2.0_7.3.0.adoc diff --git a/modules/ROOT/pages/migration/upgrading_7.3.0_8.0.0.adoc b/modules/admin/pages/migration/upgrading_7.3.0_8.0.0.adoc similarity index 100% rename from modules/ROOT/pages/migration/upgrading_7.3.0_8.0.0.adoc rename to modules/admin/pages/migration/upgrading_7.3.0_8.0.0.adoc diff --git a/modules/ROOT/pages/monitoring/prometheus.adoc b/modules/admin/pages/monitoring/prometheus.adoc similarity index 98% rename from modules/ROOT/pages/monitoring/prometheus.adoc rename to modules/admin/pages/monitoring/prometheus.adoc index c12b798cc..7f69eed0d 100644 --- a/modules/ROOT/pages/monitoring/prometheus.adoc +++ b/modules/admin/pages/monitoring/prometheus.adoc @@ -1,6 +1,7 @@ = Metrics for Prometheus :toc: right :description: Infinite Scale exposes metrics in the prometheus format. This document gives more details how to implement and access it. +:page-aliases: ROOT:monitoring/prometheus.adoc == Introduction diff --git a/modules/ROOT/pages/prerequisites/prerequisites.adoc b/modules/admin/pages/prerequisites/prerequisites.adoc similarity index 99% rename from modules/ROOT/pages/prerequisites/prerequisites.adoc rename to modules/admin/pages/prerequisites/prerequisites.adoc index e9afb017f..57475119d 100644 --- a/modules/ROOT/pages/prerequisites/prerequisites.adoc +++ b/modules/admin/pages/prerequisites/prerequisites.adoc @@ -2,6 +2,7 @@ :toc: right :toclevels: 2 :description: The prerequisites section gives an overview and background about minimum requirements with respect to hardware, virtualization, operating system and optional software to operate Infinite Scale successfully. +:page-aliases: ROOT:prerequisites/prerequisites.adoc :ext4_url: https://en.wikipedia.org/wiki/Ext4 :btrfs_url: https://en.wikipedia.org/wiki/Btrfs diff --git a/modules/ROOT/pages/security/security.adoc b/modules/admin/pages/security/security.adoc similarity index 98% rename from modules/ROOT/pages/security/security.adoc rename to modules/admin/pages/security/security.adoc index e38976ea7..78c5426fc 100644 --- a/modules/ROOT/pages/security/security.adoc +++ b/modules/admin/pages/security/security.adoc @@ -1,6 +1,7 @@ = Security Aspects of Infinite Scale :toc: right :description: This document gives you an overview of the different security measures of Infinite Scale. +:page-aliases: ROOT: security/security.adoc == Introduction diff --git a/modules/ROOT/partials/.gitkeep b/modules/admin/partials/.gitkeep similarity index 100% rename from modules/ROOT/partials/.gitkeep rename to modules/admin/partials/.gitkeep diff --git a/modules/ROOT/partials/depl-examples/ubuntu-compose/shared-setup.adoc b/modules/admin/partials/depl-examples/ubuntu-compose/shared-setup.adoc similarity index 100% rename from modules/ROOT/partials/depl-examples/ubuntu-compose/shared-setup.adoc rename to modules/admin/partials/depl-examples/ubuntu-compose/shared-setup.adoc diff --git a/modules/ROOT/partials/deployment/demo_user_table.adoc b/modules/admin/partials/deployment/demo_user_table.adoc similarity index 100% rename from modules/ROOT/partials/deployment/demo_user_table.adoc rename to modules/admin/partials/deployment/demo_user_table.adoc diff --git a/modules/ROOT/partials/deployment/services/auth-service-family.adoc b/modules/admin/partials/deployment/services/auth-service-family.adoc similarity index 100% rename from modules/ROOT/partials/deployment/services/auth-service-family.adoc rename to modules/admin/partials/deployment/services/auth-service-family.adoc diff --git a/modules/ROOT/partials/deployment/services/env-and-yaml.adoc b/modules/admin/partials/deployment/services/env-and-yaml.adoc similarity index 100% rename from modules/ROOT/partials/deployment/services/env-and-yaml.adoc rename to modules/admin/partials/deployment/services/env-and-yaml.adoc diff --git a/modules/ROOT/partials/deployment/services/log-service-ecosystem.adoc b/modules/admin/partials/deployment/services/log-service-ecosystem.adoc similarity index 100% rename from modules/ROOT/partials/deployment/services/log-service-ecosystem.adoc rename to modules/admin/partials/deployment/services/log-service-ecosystem.adoc diff --git a/modules/ROOT/partials/deployment/services/translations.adoc b/modules/admin/partials/deployment/services/translations.adoc similarity index 100% rename from modules/ROOT/partials/deployment/services/translations.adoc rename to modules/admin/partials/deployment/services/translations.adoc diff --git a/modules/ROOT/partials/maintenance/ocis-shares-cli.adoc b/modules/admin/partials/maintenance/ocis-shares-cli.adoc similarity index 100% rename from modules/ROOT/partials/maintenance/ocis-shares-cli.adoc rename to modules/admin/partials/maintenance/ocis-shares-cli.adoc diff --git a/modules/ROOT/partials/multi-location/cache-store.adoc b/modules/admin/partials/multi-location/cache-store.adoc similarity index 100% rename from modules/ROOT/partials/multi-location/cache-store.adoc rename to modules/admin/partials/multi-location/cache-store.adoc diff --git a/modules/ROOT/partials/multi-location/compose-version.adoc b/modules/admin/partials/multi-location/compose-version.adoc similarity index 100% rename from modules/ROOT/partials/multi-location/compose-version.adoc rename to modules/admin/partials/multi-location/compose-version.adoc diff --git a/modules/ROOT/partials/multi-location/env_store_nodes_attribute.adoc b/modules/admin/partials/multi-location/env_store_nodes_attribute.adoc similarity index 100% rename from modules/ROOT/partials/multi-location/env_store_nodes_attribute.adoc rename to modules/admin/partials/multi-location/env_store_nodes_attribute.adoc diff --git a/modules/ROOT/partials/multi-location/event-bus.adoc b/modules/admin/partials/multi-location/event-bus.adoc similarity index 100% rename from modules/ROOT/partials/multi-location/event-bus.adoc rename to modules/admin/partials/multi-location/event-bus.adoc diff --git a/modules/ROOT/partials/multi-location/get-bearer-token.adoc b/modules/admin/partials/multi-location/get-bearer-token.adoc similarity index 100% rename from modules/ROOT/partials/multi-location/get-bearer-token.adoc rename to modules/admin/partials/multi-location/get-bearer-token.adoc diff --git a/modules/ROOT/partials/multi-location/idm-https-reverse-proxy.adoc b/modules/admin/partials/multi-location/idm-https-reverse-proxy.adoc similarity index 100% rename from modules/ROOT/partials/multi-location/idm-https-reverse-proxy.adoc rename to modules/admin/partials/multi-location/idm-https-reverse-proxy.adoc diff --git a/modules/ROOT/partials/multi-location/ocm-sciencemesh.adoc b/modules/admin/partials/multi-location/ocm-sciencemesh.adoc similarity index 100% rename from modules/ROOT/partials/multi-location/ocm-sciencemesh.adoc rename to modules/admin/partials/multi-location/ocm-sciencemesh.adoc diff --git a/modules/ROOT/partials/multi-location/tab-text.adoc b/modules/admin/partials/multi-location/tab-text.adoc similarity index 100% rename from modules/ROOT/partials/multi-location/tab-text.adoc rename to modules/admin/partials/multi-location/tab-text.adoc diff --git a/modules/admin/partials/nav.adoc b/modules/admin/partials/nav.adoc new file mode 100644 index 000000000..6882898a0 --- /dev/null +++ b/modules/admin/partials/nav.adoc @@ -0,0 +1,116 @@ +// note that the module reference post xref is a mandatory element +* Admin Manual + +** xref:admin:index.adoc[Introduction] + +** Infinite Scale Overview +*** xref:admin:architecture/architecture.adoc[Architecture and Concepts] +*** xref:admin:availability_scaling/availability_scaling.adoc[Availability and Scalability] +*** xref:admin:security/security.adoc[Security Aspects] + +** xref:admin:deployment/index.adoc[Deployment] +*** xref:admin:prerequisites/prerequisites.adoc[Prerequisites] +*** Storage +**** xref:admin:deployment/storage/general-considerations.adoc[General Storage Considerations] +**** xref:admin:deployment/storage/nfs.adoc[Network File System] +**** xref:admin:deployment/storage/s3.adoc[S3] +**** xref:admin:deployment/storage/posixfs.adoc[PosixFS] +*** xref:admin:deployment/general/general-info.adoc[General Information] +*** xref:admin:deployment/general/ocis-init.adoc[The ocis init Command] +*** xref:admin:deployment/wopi/wopi.adoc[Office Applications using WOPI] +*** xref:admin:deployment/security/security.adoc[Securing oCIS] +*** xref:admin:deployment/gdpr/gdpr.adoc[User Triggered GDPR Report] +*** xref:admin:deployment/services/services.adoc[Services] +**** General Information +***** xref:admin:deployment/services/deployment-considerations.adoc[Deployment Considerations] +***** xref:admin:deployment/services/env-var-note.adoc[Environment Variable Notes] +***** xref:admin:deployment/services/env-vars-special-scope.adoc[Environment Variables with Special Scope] +***** xref:admin:deployment/services/env-var-changes.adoc[Environment Variable Changes] +***** xref:admin:deployment/services/registry.adoc[Registry] +***** xref:admin:deployment/services/caching.adoc[Caching and Persistence] +***** xref:admin:deployment/services/gateways.adoc[Gateways] +***** xref:admin:deployment/services/logging.adoc[Logging] +***** xref:admin:deployment/services/ports-used.adoc[Ports Used] +***** xref:admin:deployment/services/tls.adoc[Transport Layer Security] +**** List of Services +***** xref:admin:deployment/services/s-list/activitylog.adoc[Activitylog] +***** xref:admin:deployment/services/s-list/antivirus.adoc[Antivirus] +***** xref:admin:deployment/services/s-list/app-provider.adoc[App Provider] +***** xref:admin:deployment/services/s-list/app-registry.adoc[App Registry] +***** xref:admin:deployment/services/s-list/audit.adoc[Audit] +***** xref:admin:deployment/services/s-list/auth-app.adoc[Auth App] +***** xref:admin:deployment/services/s-list/auth-basic.adoc[Auth Basic] +***** xref:admin:deployment/services/s-list/auth-bearer.adoc[Auth Bearer] +***** xref:admin:deployment/services/s-list/auth-machine.adoc[Auth Machine] +***** xref:admin:deployment/services/s-list/auth-service.adoc[Auth Service] +***** xref:admin:deployment/services/s-list/clientlog.adoc[Clientlog] +***** xref:admin:deployment/services/s-list/collaboration.adoc[Collaboration] +***** xref:admin:deployment/services/s-list/eventhistory.adoc[Eventhistory] +***** xref:admin:deployment/services/s-list/frontend.adoc[Frontend] +***** xref:admin:deployment/services/s-list/gateway.adoc[Gateway] +***** xref:admin:deployment/services/s-list/graph.adoc[Graph] +***** xref:admin:deployment/services/s-list/groups.adoc[Groups] +***** xref:admin:deployment/services/s-list/idm.adoc[IDM] +***** xref:admin:deployment/services/s-list/invitations.adoc[Invitations] +***** xref:admin:deployment/services/s-list/idp.adoc[IDP] +***** xref:admin:deployment/services/s-list/nats.adoc[NATS] +***** xref:admin:deployment/services/s-list/notifications.adoc[Notifications] +***** xref:admin:deployment/services/s-list/ocdav.adoc[OCDAV] +***** xref:admin:deployment/services/s-list/ocm.adoc[OCM] +***** xref:admin:deployment/services/s-list/ocs.adoc[OCS] +***** xref:admin:deployment/services/s-list/policies.adoc[Policies] +***** xref:admin:deployment/services/s-list/postprocessing.adoc[Postprocessing] +***** xref:admin:deployment/services/s-list/proxy.adoc[Proxy] +***** xref:admin:deployment/services/s-list/search.adoc[Search] +***** xref:admin:deployment/services/s-list/settings.adoc[Settings] +***** xref:admin:deployment/services/s-list/sharing.adoc[Sharing] +***** xref:admin:deployment/services/s-list/sse.adoc[SSE] +***** xref:admin:deployment/services/s-list/store.adoc[Store] +***** xref:admin:deployment/services/s-list/storage-publiclink.adoc[Storage-Publiclink] +***** xref:admin:deployment/services/s-list/storage-shares.adoc[Storage-Shares] +***** xref:admin:deployment/services/s-list/storage-system.adoc[Storage-System] +***** xref:admin:deployment/services/s-list/storage-users.adoc[Storage-Users] +***** xref:admin:deployment/services/s-list/thumbnails.adoc[Thumbnails] +***** xref:admin:deployment/services/s-list/userlog.adoc[Userlog] +***** xref:admin:deployment/services/s-list/users.adoc[Users] +***** xref:admin:deployment/services/s-list/web.adoc[Web] +***** xref:admin:deployment/services/s-list/webdav.adoc[WebDAV] +***** xref:admin:deployment/services/s-list/webfinger.adoc[Webfinger] +*** Web UI +**** xref:admin:deployment/webui/webui-customisation.adoc[Custom Configuration] +**** xref:admin:deployment/webui/webui-theming.adoc[Custom Theming] + +** Maintenance +*** Backup and Restore +**** xref:admin:maintenance/b-r/backup_considerations.adoc[Backup Considerations] +**** xref:admin:maintenance/b-r/backup.adoc[Backup] +**** xref:admin:maintenance/b-r/restore.adoc[Restore] +*** xref:admin:maintenance/commands/commands.adoc[Maintenance Commands] +*** xref:admin:maintenance/m-mode/maintenance-mode.adoc[Maintenance Mode] +*** xref:admin:maintenance/space-ids/space-ids.adoc[Listing Space IDs] +*** xref:admin:maintenance/user-ids/user-ids.adoc[Listing User IDs] + +** Migration and Upgrades +*** xref:admin:migration/upgrading-ocis.adoc[Upgrading Infinite Scale] + +** Monitoring +*** xref:admin:monitoring/prometheus.adoc[Prometheus] + +** Configuration Examples +*** xref:admin:conf-examples/office/office-integration.adoc[Office Integration] +*** xref:admin:conf-examples/search/configure-search.adoc[Search] + +** Deployment Examples +*** Ubuntu with Docker Compose +**** xref:admin:depl-examples/ubuntu-compose/ubuntu-compose-prod.adoc[Local Production Setup] +**** xref:admin:depl-examples/ubuntu-compose/ubuntu-compose-hetzner.adoc[Deployment on Hetzner] +*** Setup Federations +**** xref:admin:depl-examples/federation/sciencemesh.adoc[ScienceMesh Setup] + +** Additional Information +*** xref:admin:additional-information/knowledge-base.adoc[Knowledge Base] + +//// +** Migration +*** xref:admin:migration/index.adoc[Migrating from ownCloud 10 to ownCloud Infinite Scale] +//// diff --git a/modules/developer/index.adoc b/modules/developer/index.adoc new file mode 100644 index 000000000..0862b0235 --- /dev/null +++ b/modules/developer/index.adoc @@ -0,0 +1,45 @@ += Infinite Scale Developer Documentation +:toc: right +:toclevels: 2 +:description: Welcome to the Infinite Scale developer documentation. Infinite Scale is a data platform providing tools to integrate, organize, share and govern data and metadata. + +## Admin Documentation + +Before you start reading, if you are interested in: + +- learning ocis from an admin perspective, +- different deployment scenarios, +- deployment examples, +- detailed settings and more + +we would recommend to continue with the [ownCloud Admin Documentation for Infinite Scale](https://doc.owncloud.com/ocis/latest/). + +## Developer Documentation + +Welcome to our developer documentation. Here you find documentation with focus for *developers*: + +- [oCIS]({{< ref "./ocis" >}}) server +- oCIS Services +- Clients like: + - [ownCloud Web](https://github.com/owncloud/web) - the new web frontend for oCIS and ownCloud + - [ownCloud Android app](https://github.com/owncloud/android) + - [ownCloud iOS app](https://github.com/owncloud/ios-app) + - [ownCloud Desktop Syncing Client](https://github.com/owncloud/client) +- Integrations + +## We Love Open Source + +The oCIS server is Apache v2 licensed. +The lower storage layer of oCIS is defined by the CS3 APIs and implemented in the REVA project. Our goal is to develop the CS3 APIs to an open standard and collaborate on the open source REVA reference implementation for CS3 APIs. + +You can also find all client sources on https://github.com/owncloud/[GitHub]. + +## Join the oCIS Community + +The https://github.com/owncloud/ocis[ocis repository] is a good entry point to the oCIS project. In addition to that, there are also ownCloud projects for apps such as https://github.com/owncloud/ios-app[iOS], https://github.com/owncloud/android[Android], the https://github.com/owncloud/desktop[Desktop] platforms and https://github.com/owncloud/web[ownCloud Web]. + +To chat about development, join our public chat on https://matrix.to/#/#ocis:matrix.org[matrix: ownCloud Infinite Scale]. + +If you want to help and improve ownCloud or oCIS, start coding or open issues on GitHub in the related repository. + +We are very happy to hear your feedback and ideas! diff --git a/modules/developer/notes_for_the_navigation_file_nav.txt b/modules/developer/notes_for_the_navigation_file_nav.txt new file mode 100644 index 000000000..f86388b91 --- /dev/null +++ b/modules/developer/notes_for_the_navigation_file_nav.txt @@ -0,0 +1,13 @@ +The navigation files have been relocated and are accessed differently now. + +The main nav.adoc file is in ROOT and includes all nav.adoc files from the modules. To do so, the modules nav.adoc files needed to be relocated from: + +{modulesdir}/nav.adoc +to +{modulesdir}/partials/nav.adoc + +This is due to the fact that "Antora does not classify files located at the root of the module or in the modules folder" which means, there is no access path to a nav.adoc file which is located in the root of a module. + +As a result, the antora.yml file only contains the main ROOT/nav.adoc file. + +This is beneficial, as we now can structure products and their content in a better way. diff --git a/modules/developer/pages/index.adoc b/modules/developer/pages/index.adoc new file mode 100644 index 000000000..7030d2b40 --- /dev/null +++ b/modules/developer/pages/index.adoc @@ -0,0 +1,51 @@ += Infinite Scale Developer Documentation +:toc: right +:toclevels: 2 +:description: Welcome to the Infinite Scale developer documentation. Infinite Scale is a data platform providing tools to integrate, organize, share and govern data and metadata. This guide provides information on developer related topics. + +include::admin:partial$multi-location/compose-version.adoc[] + +== Introduction + +{description} + +== Target Audience + +This documentation addresses developers only. + +See the xref:admin:index.adoc[admin] documnetation for prerequisites, configurations and deployment examples. + +== Release Life Cycle + +Starting with version 6 of Infinite Scale, releases are now split into `production` and `rolling`. See the https://owncloud.dev/ocis/release_roadmap/[Developer Docs Release Life Cycle] page for more details and impacts. + +You can find more details on changes made in each release published in the https://doc.owncloud.com/ocis_release_notes.html[Infinite Scale Server Release Notes]. + +IMPORTANT: Rolling releases are published in a cycle of 3 weeks. Due to this relative short cycle, you will find the actual development and the current published rolling release documentation *not* separated. They are both part of the `next` segment in the URL. Compared to production releases where the respective release number is used, the actual rolling release number published can be found e.g. in each service description in section "Environment Variables". + +== We Love Open Source + +The oCIS is Apache v2 licensed. + +The lower storage layer of oCIS is defined by the CS3 APIs and implemented in the REVA project. Our goal is to develop the CS3 APIs to an open standard and collaborate on the open source REVA reference implementation for CS3 APIs. + +You can also find all app sources at:: ++ +-- +- https://github.com/owncloud/android[ownCloud Android App] +- https://github.com/owncloud/ios-app[ownCloud iOS App] +- https://github.com/owncloud/client[ownCloud Desktop App] +-- + +== Join the oCIS Community + +The https://github.com/owncloud/ocis[oCIS repository] is a good entry point to the oCIS project. The https://github.com/owncloud/web[Web repository] provides the web frontend for oCIS. + +To chat about development, join our public chat on https://matrix.to/#/#ocis:matrix.org[matrix: ownCloud Infinite Scale]. + +If you want to help and improve, start coding or open issues on GitHub in the related repositories. + +We are very happy to hear your feedback and ideas! + +== End-User License Agreement (EULA) + +ownCloud provides an EULA to clarify, among various topics, who can use this software and which conditions apply to the groups of users defined. See the actual {compose_raw_url}{compose_version}/assets/End-User-License-Agreement-for-ownCloud-Infinite-Scale.pdf[EULA] for details. diff --git a/modules/developer/partials/nav.adoc b/modules/developer/partials/nav.adoc new file mode 100644 index 000000000..b0c2e8d71 --- /dev/null +++ b/modules/developer/partials/nav.adoc @@ -0,0 +1,4 @@ +// note that the module reference post xref is a mandatory element +* Developer Manual + +** xref:developer:index.adoc[Introduction] diff --git a/site.yml b/site.yml index 3342c4bab..7853d6896 100644 --- a/site.yml +++ b/site.yml @@ -10,16 +10,30 @@ content: branches: - HEAD +urls: + # https://docs.antora.org/antora/latest/playbook/urls-redirect-facility/ + redirect_facility: static + # see https://docs.antora.org/antora/latest/playbook/urls-latest-prerelease-version-segment/ + # for multi version components, the prerelease key defines if the latest segment is shown in the URL or only redirected when entered + latest_version_segment: latest + # latest_prerelease_version_segment: next # do not enable, we are not using this. the upcoming release version is unknown + latest_version_segment_strategy: replace # default, do not change. GH Pages currently do not support 302 as gitlab does + +runtime: + fetch: true + cache_dir: ./.cache + +output: + clean: true + dir: public + ui: + # supplemental_files: supplemental output_dir: assets bundle: snapshot: true url: https://github.com/owncloud/docs-ui/releases/download/latest/ui-bundle.zip -output: - clean: true - dir: public - asciidoc: attributes: # branch-specific-variables: 'see antora.yml' @@ -30,8 +44,8 @@ asciidoc: # Versions mainly for printing like in docs-main release info. # Versions in the ocis docs need to be defined in the branch specific docs-ocis/antora.yaml file. # To do so, change the values in the branch of docs-ocis/antora.yml like service_xxx and compose_xxx. - ocis-actual-version: '7.2.0' - ocis-former-version: '7.1.3' + ocis-actual-version: '8.0.0' + ocis-former-version: '7.3.0' extensions: - ./ext-asciidoc/tabs.js - ./ext-asciidoc/remote-include-processor.js