Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 4 additions & 65 deletions modules/ROOT/pages/index.adoc
Original file line number Diff line number Diff line change
@@ -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

Expand Down
105 changes: 2 additions & 103 deletions modules/ROOT/partials/nav.adoc
Original file line number Diff line number Diff line change
@@ -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]
////
File renamed without changes.
File renamed without changes.
File renamed without changes.
13 changes: 13 additions & 0 deletions modules/admin/notes_for_the_navigation_file_nav.txt
Original file line number Diff line number Diff line change
@@ -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.
Original file line number Diff line number Diff line change
@@ -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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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/
Expand Down
Original file line number Diff line number Diff line change
@@ -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/

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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[]

Expand Down
Original file line number Diff line number Diff line change
@@ -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[]

Expand Down
Original file line number Diff line number Diff line change
@@ -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

Expand Down
Original file line number Diff line number Diff line change
@@ -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

Expand Down
Original file line number Diff line number Diff line change
@@ -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

Expand Down
Original file line number Diff line number Diff line change
@@ -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}

Expand Down
Original file line number Diff line number Diff line change
@@ -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

Expand Down
Original file line number Diff line number Diff line change
@@ -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

Expand Down
Original file line number Diff line number Diff line change
@@ -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

Expand Down
Original file line number Diff line number Diff line change
@@ -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}

Expand Down
Original file line number Diff line number Diff line change
@@ -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

Expand Down
Original file line number Diff line number Diff line change
@@ -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

Expand Down
Original file line number Diff line number Diff line change
@@ -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

Expand Down
Original file line number Diff line number Diff line change
@@ -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

Expand Down
Original file line number Diff line number Diff line change
@@ -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

Expand Down
Original file line number Diff line number Diff line change
@@ -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

Expand Down
Original file line number Diff line number Diff line change
@@ -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

Expand Down
Loading