Skip to content

Preset for Navigation Structure #117

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tbsbdr merged 2 commits into from
Feb 28, 2025
Merged

Preset for Navigation Structure #117

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d0167d3
Preset for Navigation Structure
tbsbdr Feb 28, 2025
8dd3ef3
removed icons from navbar
tbsbdr Feb 28, 2025
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
7 changes: 7 additions & 0 deletions docs/admin/10-welcome/10-faq.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
sidebar_position: 1
id: faq
title: FAQ
draft: true
---
## FAQ
11 changes: 3 additions & 8 deletions docs/admin/whats-new.md → docs/admin/10-welcome/20-features.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,10 @@
---
sidebar_position: 2
id: releasenotes
title: Whats new?
id: features
title: Features
draft: false
---
# 2025 February 25

**Releasenotes OpenCloud 1.0.0**

Say hello to OpenCloud 1.0.0! A fresh take on secure file sharing & collaboration! Built as a fork of ocis, OpenCloud is all about doing things right. No unnecessary fluff, no distractions—just rock-solid data management, great user experience, secure and convenient administration and an awesome service by our support team.

We believe in keeping things simple but powerful.

## **🚀 Key Features at a Glance**

Expand Down
19 changes: 3 additions & 16 deletions docs/admin/intro.md → docs/admin/10-welcome/30-datasheet.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,22 +1,9 @@
---
sidebar_position: 1
id: intro
title: Welcome
sidebar_position: 3
id: datasheet
title: Datasheet
---

# Documentation for OpenCloud Administrators

# Technical Datasheet

## System Requirements

| Category | Details |
|:-----------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **Server Operating System** | <ul><li>Linux</li><li>MacOS or Windows WSL (for testing and development)</li></ul> |
| **Database** | <ul><li>None 🤠 (OpenCloud stores files exclusively on the storage to minimize complexity and ensure maximum reliability)</li></ul> |
| **Storage** | <ul><li>Local storage: Classic file storage on a local file system with POSIX compatibility (e.g., ext4, XFS, ZFS)</li><li>S3</li><li>NFS</li><li>CephFS (Q3 / 2025)</li><li>GPFS (Q3 / 2025)</li></ul> |
| **Hardware requirements** | Minimum (Small Deployment - Up to 10 Users) <ul><li>eg. Raspberry Pi 3</li><li>1 GHz (Single-core)</li><li>512 MB Ram</li><li>Storage: depends on data usage</li></ul> Medium (Deployment - Up to 1,000 Users) <ul><li>2 GHz (Dual-core)</li><li>8 GB Ram</li><li>Storage: depends on data usage</li></ul> General: <ul><li>Disk Performance (IOPS): Input/output operations per second (IOPS) should be unrestricted for maintaining optimal performance.</li><li>The server requirements vary based on load factors such as requests per second, number of client devices per user, file volume, post-processing tasks, and additional apps like Collabora. Proper sizing depends on these variables and should be adjusted accordingly.</li></ul> |


## Deployment Options

Expand Down
4 changes: 4 additions & 0 deletions docs/admin/10-welcome/_category_.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Welcome",
"position": 1
}
23 changes: 23 additions & 0 deletions docs/admin/10-welcome/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: Welcome!
slug: /admin/intro
draft: false
---

# 🙋🏻‍♀️ Welcome to OpenCloud Admin Docs

Welcome to **OpenCloud**, your self-hosted file sharing platform: Secure, simple and reliable. This documentation helps you **geting started, configure, and maintain** OpenCloud.

## Quick start
```bash
curl -L https://raw.githubusercontent.com/dragotin/thisnthat/refs/heads/master/scripts/quickoc.sh | /bin/bash
```


## What’s Inside?
1. **Getting Started** – Set up and deploy OpenCloud
2. **Configuration** – Customize and integrate with existing systems and storage `coming soon`
3. **Maintenance** – Learn how to update, backup and migrate `coming soon`

## Need Help?
Check our **FAQs `coming soon`, [Github Discussion](https://github.com/orgs/opencloud-eu/discussions), or [Matrix Channel](https://matrix.to/#/#opencloud:matrix.org)**. Let’s get started! 🚀
16 changes: 16 additions & 0 deletions docs/admin/20-getting-started/10_requirements.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
sidebar_position: 1
id: requirements
title: Requirements
draft: false
description: "Runs on anything from a Raspberry Pi to a data center."
---


| Category | Details |
|:-----------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **Server Operating System** | <ul><li>Linux</li><li>MacOS or Windows WSL (for testing and development)</li></ul> |
| **Database** | <ul><li>None 🤠 (OpenCloud stores files exclusively on the storage to minimize complexity and ensure maximum reliability)</li></ul> |
| **Storage** | <ul><li>Local storage: Classic file storage on a local file system with POSIX compatibility (e.g., ext4, XFS, ZFS)</li><li>S3</li><li>NFS</li><li>CephFS (Q3 / 2025)</li><li>GPFS (Q3 / 2025)</li></ul> |
| **Hardware requirements** | Minimum (Small Deployment - Up to 10 Users) <ul><li>eg. Raspberry Pi 3</li><li>1 GHz (Single-core)</li><li>512 MB Ram</li><li>Storage: depends on data usage</li></ul> Medium (Deployment - Up to 1,000 Users) <ul><li>2 GHz (Dual-core)</li><li>8 GB Ram</li><li>Storage: depends on data usage</li></ul> General: <ul><li>Disk Performance (IOPS): Input/output operations per second (IOPS) should be unrestricted for maintaining optimal performance.</li><li>The server requirements vary based on load factors such as requests per second, number of client devices per user, file volume, post-processing tasks, and additional apps like Collabora. Proper sizing depends on these variables and should be adjusted accordingly.</li></ul> |

32 changes: 13 additions & 19 deletions docs/admin/installation/docker-compose.md → ...n/20-getting-started/20_docker_compose.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,37 +1,34 @@
---
sidebar_position: 3
sidebar_position: 2
id: docker-compose
title: Quickstart with docker compose
title: Docker Compose
description: "🌟 Full-blown featureset including web office and full-text search."
---

# Docker Compose
<br/><br/>

## Spin up a temporary local instance of OpenCloud using **Docker Compose**.
<br/><br/>

---
Spin up a temporary local instance of OpenCloud using **Docker Compose**.


### **Prerequisites:**
## **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/)
<br/><br/>

---

### 1. Download
## 1. Download

Download the `opencloud_full` folder (this folder contains a multi-file Docker Compose configuration):

```Shell
git clone https://github.com/opencloud-eu/opencloud.git
```
<br/><br/>

---

### 2. Start
## 2. Start

cd into the Docker Compose configuration folder:

Expand All @@ -48,11 +45,10 @@ docker compose up -d
<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.
<br/><br/>

---

### 3. Add local domains to /etc/hosts
## 3. Add local domains to /etc/hosts

Edit the /etc/hosts file and add the following entries for local access:

Expand All @@ -62,11 +58,10 @@ Edit the /etc/hosts file and add the following entries for local access:
127.0.0.1 wopiserver.opencloud.test
127.0.0.1 onlyoffice.opencloud.test
```
<br/><br/>

---

### 4. Login
## 4. Login

Login with your browser:
- [https://cloud.opencloud.test](https://cloud.opencloud.test)
Expand All @@ -75,15 +70,14 @@ Login with your browser:

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

### 5. Conclusion
## 5. Conclusion

Your OpenCloud server is now running and ready to use 🚀
<br/><br/>

---

### Troubleshooting
## Troubleshooting

If you encounter any issues or errors, try finding a solution here:

- [Common Issues & Help](./../common-issues.md)
- [Common Issues & Help](./../50-resources/30-common-issues.md)
25 changes: 13 additions & 12 deletions docs/admin/installation/docker.md → docs/admin/20-getting-started/30_docker.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,21 +1,22 @@
---
sidebar_position: 2
sidebar_position: 3
id: docker
title: Quickstart with docker
title: Docker
description: "Classic docker setup."
---

# Docker
<br/><br/>


## Spin up a temporary local instance of OpenCloud using **Docker**.
<br/><br/>


---

### **Prerequisites:**
- **Linux**, **Mac** or **Windows** Subsystem for Linux [(WSL)](https://learn.microsoft.com/en-us/windows/wsl/install)
- [**Docker**](https://docs.docker.com/compose/install/)
<br/><br/>


---

Expand All @@ -25,7 +26,7 @@ title: Quickstart with docker
mkdir -p $HOME/opencloud/opencloud-config
mkdir -p $HOME/opencloud/opencloud-data
```
<br/><br/>


---

Expand All @@ -34,7 +35,7 @@ mkdir -p $HOME/opencloud/opencloud-data
```Shell
docker pull opencloudeu/opencloud-rolling:latest
```
<br/><br/>


---

Expand All @@ -51,7 +52,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"/>
<br/><br/>


---

Expand All @@ -70,7 +71,7 @@ docker run \
-e OC_URL=https://localhost:9200 \
opencloudeu/opencloud-rolling:latest
```
<br/><br/>


---

Expand All @@ -82,19 +83,19 @@ Login with your browser:
- password: **admin**

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


---

### 6. Conclusion

Your OpenCloud server is now running and ready to use 🚀
<br/><br/>


---

### Troubleshooting

If you encounter any issues or errors, try finding a solution here:

- [Common Issues & Help](./../common-issues.md)
- [Common Issues & Help](./../50-resources/30-common-issues.md)
21 changes: 11 additions & 10 deletions docs/admin/installation/bare-metal.md → docs/admin/20-getting-started/40_manual.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
---
sidebar_position: 1
sidebar_position: 4
id: bare-metal
title: Quickstart Bare - Metal
title: Bare-Metal
description: "Manual, minimalist setup with essential features."
---
<br/><br/>


## User Guide for Installing OpenCloud
Follow the steps below to install and configure OpenCloud on your system.<br/>
This example is on Linux Ubuntu distribution!
<br/><br/>


---

Expand All @@ -27,7 +28,7 @@ This example is on Linux Ubuntu distribution!
```bash
git clone https://github.com/opencloud-eu/opencloud.git
```
<br/><br/>


---

Expand All @@ -52,7 +53,7 @@ This example is on Linux Ubuntu distribution!
```bash
corepack enable pnpm
```
<br/><br/>


---

Expand Down Expand Up @@ -82,7 +83,7 @@ This example is on Linux Ubuntu distribution!
```bash
./bin/opencloud server
```
<br/><br/>


---

Expand All @@ -94,16 +95,16 @@ Login with your browser:
- password: **admin**

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


---

### 5. Conclusion

Your OpenCloud server is now running and ready to use 🚀
<br/><br/>


---

### If you encounter any issues or errors, try finding a solution here:
- [Common Issues & Help](./../common-issues.md)
- [Common Issues & Help](./../50-resources/30-common-issues.md)
6 changes: 6 additions & 0 deletions docs/admin/20-getting-started/50_raspberry_pi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
sidebar_position: 5
id: raspberry-pi
title: Raspberry Pi
draft: true
---
6 changes: 6 additions & 0 deletions docs/admin/20-getting-started/60_hetzner.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
sidebar_position: 6
id: hetzner
title: Hetzner
draft: true
---
6 changes: 6 additions & 0 deletions docs/admin/20-getting-started/70_uberspace.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
sidebar_position: 7
id: uberspace
title: Uberspace
draft: true
---
6 changes: 6 additions & 0 deletions docs/admin/20-getting-started/80_kubernetes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
sidebar_position: 8
id: kubernetes
title: Kubernetes
draft: true
---
8 changes: 8 additions & 0 deletions docs/admin/20-getting-started/_category_.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"label": "Getting Started",
"position": 2,
"link": {
"type": "generated-index",
"description": "🚀 Getting Started"
}
}
0 ...min/installation/img/bare-metal/login.png → ...-getting-started/img/bare-metal/login.png
View file
Open in desktop
File renamed without changes
0 ...img/quick-guide/docker-opencloud-init.png → ...img/quick-guide/docker-opencloud-init.png
View file
Open in desktop
File renamed without changes
0 ...g/quick-guide/quick-docker-compose-up.png → ...g/quick-guide/quick-docker-compose-up.png
View file
Open in desktop
File renamed without changes
0 ...tallation/img/quick-guide/quick-login.png → ...g-started/img/quick-guide/quick-login.png
View file
Open in desktop
File renamed without changes
6 changes: 6 additions & 0 deletions docs/admin/30-configuration/10-office.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
sidebar_position: 1
id: office
title: Office
draft: true
---
Loading