From 865b722cc2d895d30c3a5dec9facd60e4313fae0 Mon Sep 17 00:00:00 2001 From: Anja Barz Date: Wed, 2 Apr 2025 12:19:23 +0200 Subject: [PATCH 1/2] change structure of folder getting started --- .../{ => 20-docker}/20-docker-compose.md | 12 +++++----- .../25-docker-compose-local.md | 9 +++---- .../{ => 20-docker}/30-docker.md | 6 ++--- .../20-docker/_category_.json | 5 ++++ .../{ => 30-other}/40-bare-metal.md | 20 ++++++++-------- .../{ => 30-other}/50-raspberry-pi.md | 24 +++++++++---------- .../30-other/_category_.json | 5 ++++ 7 files changed, 46 insertions(+), 35 deletions(-) rename docs/admin/20-getting-started/{ => 20-docker}/20-docker-compose.md (86%) rename docs/admin/20-getting-started/{ => 20-docker}/25-docker-compose-local.md (81%) rename docs/admin/20-getting-started/{ => 20-docker}/30-docker.md (86%) create mode 100644 docs/admin/20-getting-started/20-docker/_category_.json rename docs/admin/20-getting-started/{ => 30-other}/40-bare-metal.md (67%) rename docs/admin/20-getting-started/{ => 30-other}/50-raspberry-pi.md (83%) create mode 100644 docs/admin/20-getting-started/30-other/_category_.json diff --git a/docs/admin/20-getting-started/20-docker-compose.md b/docs/admin/20-getting-started/20-docker/20-docker-compose.md similarity index 86% rename from docs/admin/20-getting-started/20-docker-compose.md rename to docs/admin/20-getting-started/20-docker/20-docker-compose.md index d7e83395..34712424 100644 --- a/docs/admin/20-getting-started/20-docker-compose.md +++ b/docs/admin/20-getting-started/20-docker/20-docker-compose.md @@ -126,13 +126,13 @@ Same should appear with the other domains you are using. Example with Chrome browser: -Certificate Details +Certificate Details ✅ Check the certificate details to confirm it’s from Let's Encrypt Staging. -Certificate Details -Certificate Details +Certificate Details +Certificate Details ## 7. Apply a Real SSL Certificate Once the staging certificate works, switch to a production certificate. @@ -167,7 +167,7 @@ docker compose up -d ✅ Now, visiting `https://cloud.YOUR.DOMAIN` should show a secure connection with a valid SSL certificate. -Certificate Details +Certificate Details ## 8. Log into OpenCloud Open a browser and visit: @@ -182,10 +182,10 @@ Login with: **Password:** (your password) -Admin general +Admin general ## Troubleshooting -If you encounter any issues, check the [Common Issues & Help Guide](./../50-resources/30-common-issues.md) +If you encounter any issues, check the [Common Issues & Help](./../../50-resources/30-common-issues.md) --- diff --git a/docs/admin/20-getting-started/25-docker-compose-local.md b/docs/admin/20-getting-started/20-docker/25-docker-compose-local.md similarity index 81% rename from docs/admin/20-getting-started/25-docker-compose-local.md rename to docs/admin/20-getting-started/20-docker/25-docker-compose-local.md index 9ebe2d9b..8802887e 100644 --- a/docs/admin/20-getting-started/25-docker-compose-local.md +++ b/docs/admin/20-getting-started/20-docker/25-docker-compose-local.md @@ -39,7 +39,7 @@ Start the deployment with Docker Compose: docker compose up -d ``` -Admin general +Admin general This starts all necessary containers in the background. @@ -57,7 +57,7 @@ Edit the /etc/hosts file and add the following entries for local access: 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 +Accept self signed certificate --- @@ -69,7 +69,7 @@ Login with your browser: - user: **admin** - password: **admin** -Admin general +Admin general ### 5. Conclusion @@ -82,4 +82,5 @@ Your OpenCloud server is now running and ready to use 🚀 If you encounter any issues or errors, try finding a solution here: -- [Common Issues & Help](./../50-resources/30-common-issues.md) \ No newline at end of file +- [Common Issues & Help](./../../50-resources/30-common-issues.md) + diff --git a/docs/admin/20-getting-started/30-docker.md b/docs/admin/20-getting-started/20-docker/30-docker.md similarity index 86% rename from docs/admin/20-getting-started/30-docker.md rename to docs/admin/20-getting-started/20-docker/30-docker.md index e9048300..08a6b70d 100644 --- a/docs/admin/20-getting-started/30-docker.md +++ b/docs/admin/20-getting-started/20-docker/30-docker.md @@ -51,7 +51,7 @@ docker run --rm -it \ You can set your own password using `IDM_ADMIN_PASSWORD=your_password`. If not set, a password will be auto-generated -Admin general +Admin general --- @@ -82,7 +82,7 @@ Login with your browser: - user: **admin** - password: **admin** -Admin general +Admin general --- @@ -98,4 +98,4 @@ Your OpenCloud server is now running and ready to use 🚀 If you encounter any issues or errors, try finding a solution here: -- [Common Issues & Help](./../50-resources/30-common-issues.md) +- [Common Issues & Help](./../../50-resources/30-common-issues.md) diff --git a/docs/admin/20-getting-started/20-docker/_category_.json b/docs/admin/20-getting-started/20-docker/_category_.json new file mode 100644 index 00000000..656deeaf --- /dev/null +++ b/docs/admin/20-getting-started/20-docker/_category_.json @@ -0,0 +1,5 @@ +{ + "label": "Docker", + "position": 2 + +} diff --git a/docs/admin/20-getting-started/40-bare-metal.md b/docs/admin/20-getting-started/30-other/40-bare-metal.md similarity index 67% rename from docs/admin/20-getting-started/40-bare-metal.md rename to docs/admin/20-getting-started/30-other/40-bare-metal.md index 13ed9d42..8c162ab6 100644 --- a/docs/admin/20-getting-started/40-bare-metal.md +++ b/docs/admin/20-getting-started/30-other/40-bare-metal.md @@ -28,13 +28,13 @@ This example is on Linux Ubuntu 24.04 distribution! ```bash sudo apt install git ``` - install git + install git - Clone the OpenCloud repository: ```bash git clone https://github.com/opencloud-eu/opencloud.git ``` - git clone + git clone --- @@ -46,19 +46,19 @@ This example is on Linux Ubuntu 24.04 distribution! ```bash sudo apt install npm -y ``` - install npm + install npm - Install corepack globally: ```bash sudo npm install -g corepack ``` - install corepack + install corepack - Enable `pnpm` using corepack: ```bash corepack enable pnpm ``` - corepack enable + corepack enable --- @@ -68,7 +68,7 @@ This example is on Linux Ubuntu 24.04 distribution! ```bash cd opencloud ``` - cd opencloud + cd opencloud - Run the build generate process: ```bash @@ -79,13 +79,13 @@ This example is on Linux Ubuntu 24.04 distribution! ```bash ./bin/opencloud init --insecure true --admin-password admin ``` - opencloud init + opencloud init - Start the OpenCloud server: ```bash ./bin/opencloud server ``` - opencloud server + opencloud server --- @@ -96,7 +96,7 @@ Login with your browser: - user: **admin** - password: **admin** -login +login --- @@ -107,4 +107,4 @@ Your OpenCloud server is now running and ready to use 🚀 --- ### If you encounter any issues or errors, try finding a solution here: -- [Common Issues & Help](./../50-resources/30-common-issues.md) \ No newline at end of file +- [Common Issues & Help](./../../50-resources/30-common-issues.md) \ No newline at end of file diff --git a/docs/admin/20-getting-started/50-raspberry-pi.md b/docs/admin/20-getting-started/30-other/50-raspberry-pi.md similarity index 83% rename from docs/admin/20-getting-started/50-raspberry-pi.md rename to docs/admin/20-getting-started/30-other/50-raspberry-pi.md index 7e8581a3..588c3b02 100644 --- a/docs/admin/20-getting-started/50-raspberry-pi.md +++ b/docs/admin/20-getting-started/30-other/50-raspberry-pi.md @@ -19,7 +19,7 @@ title: Raspberry Pi A very detailed and understandable guide is available at: [Raspberry Pi Getting Started](https://pimylifeup.com/raspberry-pi-getting-started/) - SSH must be activated -activate ssh +activate ssh - If the Raspberry Pi is to be connected to WLAN, the login data for the WLAN must be entered. @@ -28,7 +28,7 @@ title: Raspberry Pi Start the Raspberry Pi with the SD card and connect via SSH. The IP for this can be viewed in your router. -find ip from raspberry-pi in router +find ip from raspberry-pi in router #### Establish connection via SSH: ```sh @@ -65,7 +65,7 @@ sudo usermod -aG docker ${USER} ```sh groups ${USER} ``` -Check docker user +Check docker user - Reboot the Raspberry Pi to let the changes take effect @@ -83,7 +83,7 @@ sudo apt install docker-compose ```sh docker-compose --version ``` -Check docker-compose +Check docker-compose ## 1.5 Clone OpenCloud repository @@ -115,7 +115,7 @@ We will describe how you can mount an external disk or USB-Stick and make your O ```sh lsblk ``` -find the external hd +find the external hd #### 2. Format the drive to ext4 filesystem @@ -128,7 +128,7 @@ PATH-TO-DRIVE is in this example `/dev/sda1` so the command would be ```sh sudo mkfs.ext4 /dev/sda1 -L DATA ``` -format drive +format drive #### 3. Add entry in fstab for automatic mounting when restarting @@ -158,7 +158,7 @@ sudo mount -a Maybe you get following error -error mounting +error mounting then please perform the recommended command ```sh @@ -185,7 +185,7 @@ nano .env When you added an external hard disk or USB-Stick for the storage, you need to set the `OC_DATA_DIR` variable and adjust the path to your storage -change env for storage +change env for storage Here it is `/mnt/data` @@ -204,7 +204,7 @@ To make your Raspberry Pi accessible from the outside, you need a DynDNS entry ( You can create a free DynDNS account at [No-IP](https://www.noip.com/), for example. After registering, log in to the No-IP web interface and create a new host name under “Create Hostname”. In this example, we use `opencloud.webhop.me` as the address for the Raspberry Pi. -noip hostname input +noip hostname input #### 2. Configure DynDNS in your router @@ -237,7 +237,7 @@ To make your Raspberry Pi accessible from the Internet, you must set up port for 3. Create a new portforwarding with TCP for 80 and 443 Example from a Speedport 4 -portforwarding in router +portforwarding in router #### 4. Change the OpenCloud domain in the configuration @@ -262,7 +262,7 @@ docker compose down nano .env ``` 5. Look for the `OC_DOMAIN` variable and enter your URL, here we used `opencloud.webhop.me` -change the OC_DOMAIN variable +change the OC_DOMAIN variable 6. Start the docker again @@ -272,4 +272,4 @@ docker compose up Now your OpenCloud should be reachable via your URL. -reachable-via-URL \ No newline at end of file +reachable-via-URL \ No newline at end of file diff --git a/docs/admin/20-getting-started/30-other/_category_.json b/docs/admin/20-getting-started/30-other/_category_.json new file mode 100644 index 00000000..9ed3e30d --- /dev/null +++ b/docs/admin/20-getting-started/30-other/_category_.json @@ -0,0 +1,5 @@ +{ + "label": "Other", + "position": 3 + +} From ca0cec80f1d29a9d8c605f93ae44fc500917d666 Mon Sep 17 00:00:00 2001 From: Anja Barz Date: Wed, 2 Apr 2025 12:26:31 +0200 Subject: [PATCH 2/2] fix broken links and remove draft from backup --- docs/admin/40-maintenance/10-upgrade.md | 2 +- docs/admin/40-maintenance/20-backup.md | 1 - 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/admin/40-maintenance/10-upgrade.md b/docs/admin/40-maintenance/10-upgrade.md index 2a6acf45..781fbf70 100644 --- a/docs/admin/40-maintenance/10-upgrade.md +++ b/docs/admin/40-maintenance/10-upgrade.md @@ -8,7 +8,7 @@ description: "🔄 Keep your setup up to date with the latest features!" import Tabs from '@theme/Tabs' import TabItem from '@theme/TabItem' -This guide provides steps to upgrade OpenCloud for both [docker](docs/admin/20-getting-started/30-docker.md) and [docker compose](docs/admin/20-getting-started/20-docker-compose.md) +This guide provides steps to upgrade OpenCloud for both [docker](docs/admin/20-getting-started/20-docker/30-docker.md) and [docker compose](docs/admin/20-getting-started/20-docker/20-docker-compose.md) ### 1. Stop OpenCloud diff --git a/docs/admin/40-maintenance/20-backup.md b/docs/admin/40-maintenance/20-backup.md index f9af685c..8b42a6db 100644 --- a/docs/admin/40-maintenance/20-backup.md +++ b/docs/admin/40-maintenance/20-backup.md @@ -2,7 +2,6 @@ sidebar_position: 2 id: backup title: "Backup" -draft: true --- ## Regular backups are essential to ensure that your OpenCloud instance can be restored in case of issues.