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
Original file line number Diff line number Diff line change
Expand Up @@ -126,13 +126,13 @@ Same should appear with the other domains you are using.

Example with Chrome browser:

<img src={require("./img/docker-compose/certificate-details.png").default} alt="Certificate Details" width="500"/>
<img src={require("./../img/docker-compose/certificate-details.png").default} alt="Certificate Details" width="500"/>


✅ Check the certificate details to confirm it’s from Let's Encrypt Staging.

<img src={require("./img/docker-compose/certificate-viewer.png").default} alt="Certificate Details" width="500"/>
<img src={require("./img/docker-compose/subordinate-ca's.png").default} alt="Certificate Details" width="500"/>
<img src={require("./../img/docker-compose/certificate-viewer.png").default} alt="Certificate Details" width="500"/>
<img src={require("./../img/docker-compose/subordinate-ca's.png").default} alt="Certificate Details" width="500"/>

## 7. Apply a Real SSL Certificate
Once the staging certificate works, switch to a production certificate.
Expand Down Expand Up @@ -167,7 +167,7 @@ docker compose up -d

✅ Now, visiting `https://cloud.YOUR.DOMAIN` should show a secure connection with a valid SSL certificate.

<img src={require("./img/docker-compose/status-secure.png").default} alt="Certificate Details" width="1920"/>
<img src={require("./../img/docker-compose/status-secure.png").default} alt="Certificate Details" width="1920"/>

## 8. Log into OpenCloud
Open a browser and visit:
Expand All @@ -182,10 +182,10 @@ Login with:

**Password:** (your password)

<img src={require("./img/docker-compose/login.png").default} alt="Admin general" width="1920"/>
<img src={require("./../img/docker-compose/login.png").default} alt="Admin general" width="1920"/>

## 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)

---

Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Start the deployment with Docker Compose:
docker compose up -d
```

<img src={require("./img/quick-guide/quick-docker-compose-up.png").default} alt="Admin general" width="1920"/>
<img src={require("./../img/quick-guide/quick-docker-compose-up.png").default} alt="Admin general" width="1920"/>

This starts all necessary containers in the background.

Expand All @@ -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.

<img src={require("./img/quick-guide/collabora-accept-self-signed-cert.png").default} alt="Accept self signed certificate" width="1920"/>
<img src={require("./../img/quick-guide/collabora-accept-self-signed-cert.png").default} alt="Accept self signed certificate" width="1920"/>


---
Expand All @@ -69,7 +69,7 @@ Login with your browser:
- user: **admin**
- password: **admin**

<img src={require("./img/quick-guide/quick-login.png").default} alt="Admin general" width="1920"/>
<img src={require("./../img/quick-guide/quick-login.png").default} alt="Admin general" width="1920"/>


### 5. Conclusion
Expand All @@ -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)
- [Common Issues & Help](./../../50-resources/30-common-issues.md)

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

<img src={require("./img/quick-guide/docker-opencloud-init.png").default} alt="Admin general" width="1920"/>
<img src={require("./../img/quick-guide/docker-opencloud-init.png").default} alt="Admin general" width="1920"/>


---
Expand Down Expand Up @@ -82,7 +82,7 @@ Login with your browser:
- user: **admin**
- password: **admin**

<img src={require("./img/quick-guide/quick-login.png").default} alt="Admin general" width="1920"/>
<img src={require("./../img/quick-guide/quick-login.png").default} alt="Admin general" width="1920"/>


---
Expand All @@ -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)
5 changes: 5 additions & 0 deletions docs/admin/20-getting-started/20-docker/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"label": "Docker",
"position": 2

}
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,13 @@ This example is on Linux Ubuntu 24.04 distribution!
```bash
sudo apt install git
```
<img src={require("./img/bare-metal/install-git.png").default} alt="install git" width="1920"/>
<img src={require("./../img/bare-metal/install-git.png").default} alt="install git" width="1920"/>

- Clone the OpenCloud repository:
```bash
git clone https://github.com/opencloud-eu/opencloud.git
```
<img src={require("./img/bare-metal/git-clone.png").default} alt="git clone" width="1920"/>
<img src={require("./../img/bare-metal/git-clone.png").default} alt="git clone" width="1920"/>

---

Expand All @@ -46,19 +46,19 @@ This example is on Linux Ubuntu 24.04 distribution!
```bash
sudo apt install npm -y
```
<img src={require("./img/bare-metal/install-npm.png").default} alt="install npm" width="1920"/>
<img src={require("./../img/bare-metal/install-npm.png").default} alt="install npm" width="1920"/>

- Install corepack globally:
```bash
sudo npm install -g corepack
```
<img src={require("./img/bare-metal/install-corepack.png").default} alt="install corepack" width="1920"/>
<img src={require("./../img/bare-metal/install-corepack.png").default} alt="install corepack" width="1920"/>

- Enable `pnpm` using corepack:
```bash
corepack enable pnpm
```
<img src={require("./img/bare-metal/corepack-enable.png").default} alt="corepack enable" width="1920"/>
<img src={require("./../img/bare-metal/corepack-enable.png").default} alt="corepack enable" width="1920"/>

---

Expand All @@ -68,7 +68,7 @@ This example is on Linux Ubuntu 24.04 distribution!
```bash
cd opencloud
```
<img src={require("./img/bare-metal/cd-opencloud.png").default} alt="cd opencloud" width="1920"/>
<img src={require("./../img/bare-metal/cd-opencloud.png").default} alt="cd opencloud" width="1920"/>

- Run the build generate process:
```bash
Expand All @@ -79,13 +79,13 @@ This example is on Linux Ubuntu 24.04 distribution!
```bash
./bin/opencloud init --insecure true --admin-password admin
```
<img src={require("./img/bare-metal/opencloud-init.png").default} alt="opencloud init" width="1920"/>
<img src={require("./../img/bare-metal/opencloud-init.png").default} alt="opencloud init" width="1920"/>

- Start the OpenCloud server:
```bash
./bin/opencloud server
```
<img src={require("./img/bare-metal/opencloud-server.png").default} alt="opencloud server" width="1920"/>
<img src={require("./../img/bare-metal/opencloud-server.png").default} alt="opencloud server" width="1920"/>

---

Expand All @@ -96,7 +96,7 @@ Login with your browser:
- user: **admin**
- password: **admin**

<img src={require("./img/bare-metal/login.png").default} alt="login" width="1920"/>
<img src={require("./../img/bare-metal/login.png").default} alt="login" width="1920"/>

---

Expand All @@ -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)
- [Common Issues & Help](./../../50-resources/30-common-issues.md)
Original file line number Diff line number Diff line change
Expand Up @@ -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
<img src={require("./img/raspberrypi/ssh-activate.png").default} alt="activate ssh" width="500"/>
<img src={require("./../img/raspberrypi/ssh-activate.png").default} alt="activate ssh" width="500"/>

- If the Raspberry Pi is to be connected to WLAN, the login data for the WLAN must be entered.

Expand All @@ -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.

<img src={require("./img/raspberrypi/ip-router.png").default} alt="find ip from raspberry-pi in router" width="500"/>
<img src={require("./../img/raspberrypi/ip-router.png").default} alt="find ip from raspberry-pi in router" width="500"/>

#### Establish connection via SSH:
```sh
Expand Down Expand Up @@ -65,7 +65,7 @@ sudo usermod -aG docker ${USER}
```sh
groups ${USER}
```
<img src={require("./img/raspberrypi/docker-user-check.png").default} alt="Check docker user" width="500"/>
<img src={require("./../img/raspberrypi/docker-user-check.png").default} alt="Check docker user" width="500"/>

- Reboot the Raspberry Pi to let the changes take effect

Expand All @@ -83,7 +83,7 @@ sudo apt install docker-compose
```sh
docker-compose --version
```
<img src={require("./img/raspberrypi/docker-compose-check.png").default} alt="Check docker-compose" width="500"/>
<img src={require("./../img/raspberrypi/docker-compose-check.png").default} alt="Check docker-compose" width="500"/>


## 1.5 Clone OpenCloud repository
Expand Down Expand Up @@ -115,7 +115,7 @@ We will describe how you can mount an external disk or USB-Stick and make your O
```sh
lsblk
```
<img src={require("./img/raspberrypi/find-external-hd.png").default} alt="find the external hd" width="500"/>
<img src={require("./../img/raspberrypi/find-external-hd.png").default} alt="find the external hd" width="500"/>


#### 2. Format the drive to ext4 filesystem
Expand All @@ -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
```
<img src={require("./img/raspberrypi/format-drive.png").default} alt="format drive" width="500"/>
<img src={require("./../img/raspberrypi/format-drive.png").default} alt="format drive" width="500"/>

#### 3. Add entry in fstab for automatic mounting when restarting

Expand Down Expand Up @@ -158,7 +158,7 @@ sudo mount -a

Maybe you get following error

<img src={require("./img/raspberrypi/error-mounting.png").default} alt="error mounting" width="500"/>
<img src={require("./../img/raspberrypi/error-mounting.png").default} alt="error mounting" width="500"/>

then please perform the recommended command
```sh
Expand All @@ -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

<img src={require("./img/raspberrypi/change-env-for-storage.png").default} alt="change env for storage" width="500"/>
<img src={require("./../img/raspberrypi/change-env-for-storage.png").default} alt="change env for storage" width="500"/>


Here it is `/mnt/data`
Expand All @@ -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.

<img src={require("./img/raspberrypi/noip.png").default} alt="noip hostname input" width="500"/>
<img src={require("./../img/raspberrypi/noip.png").default} alt="noip hostname input" width="500"/>

#### 2. Configure DynDNS in your router

Expand Down Expand Up @@ -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
<img src={require("./img/raspberrypi/portforwarding.png").default} alt="portforwarding in router" width="500"/>
<img src={require("./../img/raspberrypi/portforwarding.png").default} alt="portforwarding in router" width="500"/>

#### 4. Change the OpenCloud domain in the configuration

Expand All @@ -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`
<img src={require("./img/raspberrypi/oc-domain.png").default} alt="change the OC_DOMAIN variable" width="500"/>
<img src={require("./../img/raspberrypi/oc-domain.png").default} alt="change the OC_DOMAIN variable" width="500"/>

6. Start the docker again

Expand All @@ -272,4 +272,4 @@ docker compose up

Now your OpenCloud should be reachable via your URL.

<img src={require("./img/raspberrypi/reachable-via-URL.png").default} alt="reachable-via-URL" width="1920"/>
<img src={require("./../img/raspberrypi/reachable-via-URL.png").default} alt="reachable-via-URL" width="1920"/>
5 changes: 5 additions & 0 deletions docs/admin/20-getting-started/30-other/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"label": "Other",
"position": 3

}
2 changes: 1 addition & 1 deletion docs/admin/40-maintenance/10-upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
1 change: 0 additions & 1 deletion docs/admin/40-maintenance/20-backup.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down