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
61 changes: 29 additions & 32 deletions docs/admin/resources/common-issues.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,13 @@
sidebar_position: 4
id: common-issues
title: Common Issues & Help
description: Common issues & help
draft: false
---

### Check whether the containers are running
# Common Issues & Help

## Check whether the containers are running

```bash
docker ps
Expand All @@ -14,43 +18,39 @@ docker ps

Several containers should be listed here, e.g., for opencloud, traefik, etc.

---

### Accept Self-Signed Certificates
## Accept Self-Signed Certificates

As the local environment is self-signed, you must accept the security risk in your browser.

For Firefox:

You need to click on **Advanced**
You need to click on Advanced

<img src={require("./img/common-issues/quick-advanced.png").default} alt="Admin general" width="500"/>

Confirm the risk with **Accept the risk and Continue**
Confirm the risk with Accept the risk and Continue

<img src={require("./img/common-issues/quick-accept-security-risk.png").default} alt="Admin general" width="500"/>

---

### Docker Permission Issues
## Docker Permission Issues

If your Docker Compose setup fails to start and the logs contain messages such as `permission denied`, it's likely due to incorrect ownership of local directories used by the containers.

**Example log output:**
Example log output:

```bash
opencloud-1 | {"level":"fatal","service":"nats","time":"2025-04-08T09:59:59Z","line":"github.com/opencloud-eu/opencloud/services/nats/pkg/logging/nats.go:33","message":"Can't start JetStream: could not create storage directory - mkdir /var/lib/opencloud/nats: permission denied"}
```

This error typically occurs when the mounted directories are owned by the wrong user, such as `root`, instead of the standard Docker user (`UID 1000`).

**Incorrect directory ownership:**
Incorrect directory ownership:

```bash
drwxr-xr-x 3 root root 4096 Apr 8 09:59 opencloud-data
```

**Correct ownership should be:**
Correct ownership should be:

```bash
drwxr-xr-x 9 1000 1000 4096 Apr 7 07:57 opencloud-data
Expand All @@ -62,7 +62,8 @@ To resolve this issue, adjust the ownership of the directory using the `chown` c
chown -R 1000:1000 opencloud-data
```

:::caution Security Warning
:::caution
Security Warning

The user with UID 1000 on your host system will have full access to these mounted directories. This means that any local user account with this ID can read, modify, or delete OpenCloud config and data files.

Expand All @@ -72,50 +73,46 @@ This can pose a security risk in shared or multi-user environments. Make sure to

Ensure you apply this to all relevant folders that are mounted into your containers. This will grant the Docker container the necessary permissions to access and write to these directories.

---

## 🔐 Change Admin Password Set in `.env`

If you initially set the OpenCloud **admin password** using the `.env` file, please note:
## Change Admin Password Set in `.env`

> ⚠️ **You cannot simply change the password again by editing the `.env` file.**
> Once the container is running, password changes must be made via the Web UI or terminal.
If you initially set the OpenCloud admin password using the `.env` file, please note:

---
:::caution
You cannot simply change the password again by editing the `.env` file.
Once the container is running, password changes must be made via the Web UI or terminal.
:::

### Option 1: Change via Web UI
### Option 1: Change via Web UI

If the current admin password is known:

1. Log in to the OpenCloud **Web Interface**.
2. Navigate to **Settings > Security**.
1. Log in to the OpenCloud Web Interface.
2. Navigate to Settings > Security.
3. Enter your current password and choose a new one.

> If the admin password is forgotten or you prefer command-line tools, use the terminal method below.

---

### 🖥️ Option 2: Change via Terminal
### Option 2: Change via Terminal

If the admin password is forgotten or needs to be changed via the terminal:

#### Step 1: Stop the Docker container
#### Stop the Docker container

First, stop your OpenCloud container:

```bash
docker compose stop opencloud
```

#### Step 2: Run the password reset command
#### Run the password reset command

Use the following command to reset the password:

```bash
sudo docker run -it --rm -v <opencloud-data-path>:/var/lib/opencloud -v <opencloud-config-path>:/etc/opencloud opencloudeu/opencloud:<opencloud-version> idm resetpassword
```

Replace:
#### Replace

`<opencloud-data-path>` – Docker volume for OpenCloud data

Expand All @@ -136,13 +133,13 @@ Look for volumes like:

`opencloud_full_opencloud-config`

💡 Example for standard setup:
#### Example for standard setup

```bash
sudo docker run -it --rm -v opencloud_full_opencloud-data:/var/lib/opencloud -v opencloud_full_opencloud-config:/etc/opencloud opencloudeu/opencloud:latest idm resetpassword
```

#### Step 3: Start the container again
#### Start the container again

```bash
docker compose up -d
Expand Down
44 changes: 19 additions & 25 deletions docs/admin/resources/demo-user.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,15 @@
sidebar_position: 5
id: demo-user
title: Demo User
description: Demo User Overview
draft: false
---

# **Demo User Overview**
# Demo User Overview

This page introduces the pre-configured demo users available in OpenCloud. These users are designed to help you explore the platform’s features, test different roles, and experience OpenCloud from various perspectives without setting up new accounts.

Each demo user has specific permissions and access levels, allowing you to simulate real-world scenarios such as **admin management, file sharing, and collaboration**.
Each demo user has specific permissions and access levels, allowing you to simulate real-world scenarios such as admin management, file sharing, and collaboration.

Below, you’ll find details about each user, including their roles and login credentials.

Expand All @@ -22,27 +24,25 @@ Below, you’ll find details about each user, including their roles and login cr

## Dennis Ritchie

OpenCloud Username: **dennis**
OpenCloud Username: dennis

Role: **Admin**
Role: Admin

📌 **Co-developer of UNIX & inventor of the C programming language**
Co-developer of UNIX & inventor of the C programming language

<img src={require("./img/demo-user/dennis-ritchie.png").default} alt="Dennis Ritchie" width="200"/>

- Studied physics and applied mathematics at Harvard University
- Worked at Bell Labs from 1967, where he developed the first version of the Unix operating system
- Died in 2011, but his influence on modern software development remains immeasurable

---

## Margaret Hamilton

OpenCloud Username: **margaret**
OpenCloud Username: margaret

Role: **Space Admin**
Role: Space Admin

📌 **Software pioneer & NASA developer**
Software pioneer & NASA developer

<img src={require("./img/demo-user/margaret-hamilton.png").default} alt="Margaret Hamilton" width="200"/>

Expand All @@ -51,15 +51,13 @@ Role: **Space Admin**
- Her work was crucial to the success of the Apollo 11 mission in 1969
- From 1976 to 1984, she was the Managing Director of Higher Order Software (HOS)

---

## Alan Turing

OpenCloud Username: **alan**
OpenCloud Username: alan

Role: **User**
Role: User

📌 **Father of modern computer science & codebreaker in the Second World War**
Father of modern computer science & codebreaker in the Second World War

<img src={require("./img/demo-user/alan-turing.png").default} alt="Alan Turing" width="200"/>

Expand All @@ -68,15 +66,13 @@ Role: **User**
- Made a decisive contribution to the decryption of the German Enigma cipher
- Was discriminated against and persecuted because of his homosexuality

---

## Lynn Conway

OpenCloud Username: **lynn**
OpenCloud Username: lynn

Role: **User**
Role: User

📌 Computer scientist & microchip design pioneer
Computer scientist & microchip design pioneer

<img src={require("./img/demo-user/lynn-conway.png").default} alt="Lynn Conway" width="200"/>

Expand All @@ -86,15 +82,13 @@ Role: **User**
- Professor of electrical engineering and computer science at the University of Michigan
- Advocate for transgender rights and diversity in STEM fields

---

## Mary Kenneth Keller

OpenCloud Username: **mary**
OpenCloud Username: mary

Role: **User**
Role: User

📌 **First woman with a PhD in computer science**
First woman with a PhD in computer science

<img src={require("./img/demo-user/mary-kenneth-keller.png").default} alt="Mary Kenneth Keller" width="200"/>

Expand Down
40 changes: 24 additions & 16 deletions docs/admin/resources/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,24 @@
sidebar_position: 1
id: faq
title: FAQ
draft: true
description: Frequently asked questions FAQ
draft: false
---

# FAQ

**Welcome to the frequently asked questions (FAQ). Here you will find answers to the most common questions.**

---
Welcome to the frequently asked questions (FAQ). Here you will find answers to the most common questions.

## General Questions

<details>
<summary>What problem does OpenCloud solve for me?</summary>

1. Simplified Administration
### Simplified Administration

OpenCloud is designed to be straightforward to set up and manage, allowing administrators to handle the system with minimal effort and without unnecessary complexity.

2. Independent File-sharing
### Independent File-sharing

OpenCloud is designed to give you a privacy-focused alternative to mainstream platforms like Microsoft OneDrive or Google Drive, freeing you from reliance on big tech services and their data-collection practices.

Expand Down Expand Up @@ -152,7 +151,7 @@ Key Factors for Optimal Performance:
<details>
<summary>How difficult is it to set up, and is technical expertise required?</summary>

One of our goals is to make the deployment of OpenCloud as simple as possible. Depending on your expereince, it's possible to set up a basic OpenCloud instance in less than 1 minute. See [https://docs.opencloud.eu/docs/category/getting-started-1](https://docs.opencloud.eu/docs/category/getting-started-1)
One of our goals is to make the deployment of OpenCloud as simple as possible. Depending on your expereince, it's possible to set up a basic OpenCloud instance in less than 1 minute. See [the Quick Start](https://docs.opencloud.eu/docs/admin/intro)

</details>

Expand All @@ -173,8 +172,8 @@ Yes.

Yes, OpenCloud allows you customizations:

- **Wordings**: You can replace specific terms, such as changing the word “Spaces” to “Datarooms” to better fit your terminology.
- **Extensions**: The web UI also supports custom web extensions. Check out our developer documentation [here] to learn how to get started with creating and adding your own extensions and find existing extensions [here].
- Wordings: You can replace specific terms, such as changing the word “Spaces” to “Datarooms” to better fit your terminology.
- Extensions: The web UI also supports custom web extensions. Check out our developer documentation [here] to learn how to get started with creating and adding your own extensions and find existing extensions [here].

</details>

Expand All @@ -185,11 +184,20 @@ Yes, OpenCloud allows you customizations:

OpenCloud offers three main ways to share files, making it easy to collaborate and manage access:

1. **Personal Share**: Share files with registered users within your organization. You can assign permissions such as view, edit, or download, providing flexible control over file access.
2. **Share via Link**: Share files with anyone, even outside your organization, by generating a link. No account is required for accessing the file.
3. **Spaces**: Spaces are user-independent datarooms that belong to the organization rather than an individual. This ensures files remain within the organization, even if users leave. Examples of Spaces include school classes, collaborative projects, or organizational units like Marketing, Sales, or Finance. Spaces are easier for admins to manage, as they can be self-managed by designated users.
### Personal Share

Share files with registered users within your organization. You can assign permissions such as view, edit, or download, providing flexible control over file access.

### Share via Link

Share files with anyone, even outside your organization, by generating a link. No account is required for accessing the file.

### Spaces

Spaces are user-independent datarooms that belong to the organization rather than an individual. This ensures files remain within the organization, even if users leave. Examples of Spaces include school classes, collaborative projects, or organizational units like Marketing, Sales, or Finance. Spaces are easier for admins to manage, as they can be self-managed by designated users.

### Special Feature: Secret File Drop

**Special Feature: Secret File Drop**
The Secret File Drop allows anonymous users to securely upload files (e.g., homework, photos or even whistleblower material) without needing an account.

</details>
Expand Down Expand Up @@ -242,9 +250,9 @@ Yes, the following storage can be used:
<details>
<summary>How often is OpenCloud updated, and how are updates delivered?</summary>

**Download updates** on download.opencloud.eu or via docker hub.
Download updates on download.opencloud.eu or via docker hub.

OpenCloud is released in three different release types: **Production, Rolling and Daily**. Each of them is targeted to a specific use case and audience group.
OpenCloud is released in three different release types: Production, Rolling and Daily. Each of them is targeted to a specific use case and audience group.

</details>

Expand Down Expand Up @@ -296,7 +304,7 @@ OpenCloud provides users with the ability to trigger a GDPR Export in a self-ser
<details>
<summary>Does OpenCloud offer multi-language support?</summary>

Yes, OpenCloud fully maintains both **English** and **German** languages. Additionally, the web UI offers support for other languages, which are listed below. Please note that these languages are not 100% translated and are maintained by the community on a best-effort basis. We appreciate the contributions from our community to help improve the language support over time.
Yes, OpenCloud fully maintains both English and German languages. Additionally, the web UI offers support for other languages, which are listed below. Please note that these languages are not 100% translated and are maintained by the community on a best-effort basis. We appreciate the contributions from our community to help improve the language support over time.

Community maintained languages:

Expand Down
Loading