From 71235e372bb3dba03a9d9a7fd39c8583b9384d94 Mon Sep 17 00:00:00 2001 From: Anja Barz Date: Wed, 10 Sep 2025 11:34:57 +0200 Subject: [PATCH 1/2] install forwarding, add plugin and url, add forward in md --- .../container/docker-compose-local.md | 109 ------------------ .../docker-compose/docker-compose-base.md | 2 + .../container/docker-compose/external-idm.md | 7 -- docusaurus.config.ts | 15 ++- package.json | 1 + pnpm-lock.yaml | 41 +++++++ 6 files changed, 57 insertions(+), 118 deletions(-) delete mode 100644 docs/admin/getting-started/container/docker-compose-local.md delete mode 100644 docs/admin/getting-started/container/docker-compose/external-idm.md diff --git a/docs/admin/getting-started/container/docker-compose-local.md b/docs/admin/getting-started/container/docker-compose-local.md deleted file mode 100644 index a5ba033d..00000000 --- a/docs/admin/getting-started/container/docker-compose-local.md +++ /dev/null @@ -1,109 +0,0 @@ ---- -sidebar_position: 3 -id: docker-compose-local -title: Docker Compose local -description: Full-blown featureset including web office and full-text search. -draft: false ---- - -# Guide for local installation - -Spin up a temporary local instance of OpenCloud using Docker Compose. - -## Prerequisites - -- Linux, Mac or Windows Subsystem for Linux [(WSL)](https://learn.microsoft.com/en-us/windows/wsl/install) -- [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) -- [Docker Compose](https://docs.docker.com/compose/install/) - -## Download - -- Clone the [OpenCloud-Compose repository](https://github.com/opencloud-eu/opencloud-compose) - -```bash -git clone https://github.com/opencloud-eu/opencloud-compose.git -``` - -## Start - -### cd into the Docker Compose configuration folder - -```bash -cd opencloud-compose -``` - -### Create environment file - -```bash -cp .env.example .env -``` - -:::note -The repository includes .env.example as a template with default settings and documentation. Your actual .env file is excluded from version control (via .gitignore) to prevent accidentally committing sensitive information like passwords and domain-specific settings. -::: - -### Configure deployment options - -- You can deploy using explicit -f flags - -```bash -docker compose -f docker-compose.yml -f weboffice/collabora.yml -f traefik/opencloud.yml -f traefik/collabora.yml up -d -``` - -- or by uncomment or adding the COMPOSE_FILE variable in .env - -```bash -COMPOSE_FILE=docker-compose.yml:weboffice/collabora.yml:traefik/opencloud.yml:traefik/collabora.yml -``` - -- Set you initial admin password in the .env - -```bash -INITIAL_ADMIN_PASSWORD=YOUR.SECRET.PASSWORD -``` - -### This is mandatory for security reasons. Otherwise the OpenCloud container will not start - -- Start the deployment with Docker Compose - -```bash -docker compose up -d -``` - -Admin general - -- This starts all necessary containers in the background - -## Add local domains to /etc/hosts - -### Edit the /etc/hosts file and add the following entries for local access - -```bash -127.0.0.1 cloud.opencloud.test -127.0.0.1 collabora.opencloud.test -127.0.0.1 wopiserver.opencloud.test -``` - -Open [https://collabora.opencloud.test](https://collabora.opencloud.test) and accept the self-signed certificate. This step is needed as you can not accept the self-signed certificate if you try to open a .odt document from within the OpenCloud Web UI as Collabora is embedded via an iframe. - -Accept self signed certificate - -## Login - -- Login with your browser - -- [https://cloud.opencloud.test](https://cloud.opencloud.test) -- user: admin -- password: YOUR.SECRET.PASSWORD - -Admin general - -## Conclusion - -- Your OpenCloud server is now running and ready to use - -## Troubleshooting - -If you encounter any issues or errors, try finding a solution here: - -- [Common Issues & Help](./../../resources/common-issues.md) diff --git a/docs/admin/getting-started/container/docker-compose/docker-compose-base.md b/docs/admin/getting-started/container/docker-compose/docker-compose-base.md index 9d2afb8b..d63a3b62 100644 --- a/docs/admin/getting-started/container/docker-compose/docker-compose-base.md +++ b/docs/admin/getting-started/container/docker-compose/docker-compose-base.md @@ -4,6 +4,8 @@ id: docker-compose-base title: Docker Compose description: Full-blown featureset including web office. draft: false +redirect_from: + - /docs/admin/getting-started/container/docker-compose-local --- # OpenCloud with Docker Compose diff --git a/docs/admin/getting-started/container/docker-compose/external-idm.md b/docs/admin/getting-started/container/docker-compose/external-idm.md deleted file mode 100644 index 3fefb817..00000000 --- a/docs/admin/getting-started/container/docker-compose/external-idm.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -sidebar_position: 3 -id: external-idm -title: With external IDM -description: OpenCloud with external IDM. -draft: true ---- diff --git a/docusaurus.config.ts b/docusaurus.config.ts index 3d553245..888df0b6 100644 --- a/docusaurus.config.ts +++ b/docusaurus.config.ts @@ -155,9 +155,20 @@ const config: Config = { } satisfies Preset.ThemeConfig, - plugins: [ - rawLoaderPlugin, +plugins: [ + rawLoaderPlugin, + [ + '@docusaurus/plugin-client-redirects', + { + redirects: [ + { + from: ['/docs/admin/getting-started/container/docker-compose-local'], + to: '/docs/admin/getting-started/container/docker-compose/docker-compose-base', + }, + ], + }, ], +], themes: [ [ diff --git a/package.json b/package.json index 571f5b63..ae8f31ee 100644 --- a/package.json +++ b/package.json @@ -22,6 +22,7 @@ }, "dependencies": { "@docusaurus/core": "3.8.1", + "@docusaurus/plugin-client-redirects": "3.8.1", "@docusaurus/preset-classic": "3.8.1", "@docusaurus/theme-common": "^3.8.1", "@docusaurus/theme-mermaid": "^3.8.1", diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 1cd189ab..896d51e3 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -11,6 +11,9 @@ importers: '@docusaurus/core': specifier: 3.8.1 version: 3.8.1(@mdx-js/react@3.1.1(@types/react@19.1.12)(react@19.1.1))(debug@4.4.1)(react-dom@19.1.1(react@19.1.1))(react@19.1.1)(typescript@5.6.3) + '@docusaurus/plugin-client-redirects': + specifier: 3.8.1 + version: 3.8.1(@mdx-js/react@3.1.1(@types/react@19.1.12)(react@19.1.1))(react-dom@19.1.1(react@19.1.1))(react@19.1.1)(typescript@5.6.3) '@docusaurus/preset-classic': specifier: 3.8.1 version: 3.8.1(@algolia/client-search@5.37.0)(@mdx-js/react@3.1.1(@types/react@19.1.12)(react@19.1.1))(@types/react@19.1.12)(react-dom@19.1.1(react@19.1.1))(react@19.1.1)(search-insights@2.17.3)(typescript@5.6.3) @@ -1098,6 +1101,13 @@ packages: react: '*' react-dom: '*' + '@docusaurus/plugin-client-redirects@3.8.1': + resolution: {integrity: sha512-F+86R7PBn6VNgy/Ux8w3ZRypJGJEzksbejQKlbTC8u6uhBUhfdXWkDp6qdOisIoW0buY5nLqucvZt1zNJzhJhA==} + engines: {node: '>=18.0'} + peerDependencies: + react: ^18.0.0 || ^19.0.0 + react-dom: ^18.0.0 || ^19.0.0 + '@docusaurus/plugin-content-blog@3.8.1': resolution: {integrity: sha512-vNTpMmlvNP9n3hGEcgPaXyvTljanAKIUkuG9URQ1DeuDup0OR7Ltvoc8yrmH+iMZJbcQGhUJF+WjHLwuk8HSdw==} engines: {node: '>=18.0'} @@ -7364,6 +7374,37 @@ snapshots: - uglify-js - webpack-cli + '@docusaurus/plugin-client-redirects@3.8.1(@mdx-js/react@3.1.1(@types/react@19.1.12)(react@19.1.1))(react-dom@19.1.1(react@19.1.1))(react@19.1.1)(typescript@5.6.3)': + dependencies: + '@docusaurus/core': 3.8.1(@mdx-js/react@3.1.1(@types/react@19.1.12)(react@19.1.1))(debug@4.4.1)(react-dom@19.1.1(react@19.1.1))(react@19.1.1)(typescript@5.6.3) + '@docusaurus/logger': 3.8.1 + '@docusaurus/utils': 3.8.1(react-dom@19.1.1(react@19.1.1))(react@19.1.1) + '@docusaurus/utils-common': 3.8.1(react-dom@19.1.1(react@19.1.1))(react@19.1.1) + '@docusaurus/utils-validation': 3.8.1(react-dom@19.1.1(react@19.1.1))(react@19.1.1) + eta: 2.2.0 + fs-extra: 11.3.1 + lodash: 4.17.21 + react: 19.1.1 + react-dom: 19.1.1(react@19.1.1) + tslib: 2.8.1 + transitivePeerDependencies: + - '@docusaurus/faster' + - '@mdx-js/react' + - '@parcel/css' + - '@rspack/core' + - '@swc/core' + - '@swc/css' + - bufferutil + - csso + - debug + - esbuild + - lightningcss + - supports-color + - typescript + - uglify-js + - utf-8-validate + - webpack-cli + '@docusaurus/plugin-content-blog@3.8.1(@docusaurus/plugin-content-docs@3.8.1(@mdx-js/react@3.1.1(@types/react@19.1.12)(react@19.1.1))(react-dom@19.1.1(react@19.1.1))(react@19.1.1)(typescript@5.6.3))(@mdx-js/react@3.1.1(@types/react@19.1.12)(react@19.1.1))(react-dom@19.1.1(react@19.1.1))(react@19.1.1)(typescript@5.6.3)': dependencies: '@docusaurus/core': 3.8.1(@mdx-js/react@3.1.1(@types/react@19.1.12)(react@19.1.1))(debug@4.4.1)(react-dom@19.1.1(react@19.1.1))(react@19.1.1)(typescript@5.6.3) From 5068c1d47b3cb9eaec341efaa97a45d58a7a3543 Mon Sep 17 00:00:00 2001 From: Michael Barz Date: Thu, 11 Sep 2025 21:02:50 +0200 Subject: [PATCH 2/2] style: use redirects file --- .../docker-compose/docker-compose-base.md | 2 -- docusaurus.config.ts | 23 +++++++------------ redirects.ts | 7 ++++++ 3 files changed, 15 insertions(+), 17 deletions(-) create mode 100644 redirects.ts diff --git a/docs/admin/getting-started/container/docker-compose/docker-compose-base.md b/docs/admin/getting-started/container/docker-compose/docker-compose-base.md index d63a3b62..9d2afb8b 100644 --- a/docs/admin/getting-started/container/docker-compose/docker-compose-base.md +++ b/docs/admin/getting-started/container/docker-compose/docker-compose-base.md @@ -4,8 +4,6 @@ id: docker-compose-base title: Docker Compose description: Full-blown featureset including web office. draft: false -redirect_from: - - /docs/admin/getting-started/container/docker-compose-local --- # OpenCloud with Docker Compose diff --git a/docusaurus.config.ts b/docusaurus.config.ts index 888df0b6..b8b9180e 100644 --- a/docusaurus.config.ts +++ b/docusaurus.config.ts @@ -1,7 +1,7 @@ import {themes as prismThemes} from 'prism-react-renderer'; import type {Config} from '@docusaurus/types'; import type * as Preset from '@docusaurus/preset-classic'; -import { rawLoaderPlugin } from './plugins' +import { redirects } from './redirects'; // This runs in Node.js - Don't use client-side code here (browser APIs, JSX...) @@ -154,21 +154,14 @@ const config: Config = { }, } satisfies Preset.ThemeConfig, - -plugins: [ - rawLoaderPlugin, - [ - '@docusaurus/plugin-client-redirects', - { - redirects: [ - { - from: ['/docs/admin/getting-started/container/docker-compose-local'], - to: '/docs/admin/getting-started/container/docker-compose/docker-compose-base', - }, - ], - }, + plugins: [ + [ + '@docusaurus/plugin-client-redirects', + { + redirects, + }, + ], ], -], themes: [ [ diff --git a/redirects.ts b/redirects.ts new file mode 100644 index 00000000..d6224d82 --- /dev/null +++ b/redirects.ts @@ -0,0 +1,7 @@ +export const redirects = [ + { + to: '/docs/admin/getting-started/container/docker-compose/docker-compose-base', + from: ['/docs/admin/getting-started/container/docker-compose-local'], + }, + // Add more redirects here as needed +];