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
105 changes: 105 additions & 0 deletions docs/admin/installation/bare-metal.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
---
sidebar_position: 4
id: bare-metal
title: Quickstart Bare - Metal
---
<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/>

---

### Step 1: Install Git and clone the repository

1. Open a terminal.
2. Update your package list:
```bash
sudo apt update
```
3. Install Git using the following command:
```bash
sudo apt install git
```
4. Clone the OpenCloud repository:
```bash
git clone https://github.com/opencloud-eu/opencloud.git
```
<br/><br/>

---

### Step 2: Update system and install required packages

Comment thread
AlexAndBear marked this conversation as resolved.
1. Install the golang package:
```bash
sudo apt install golang -y
```

2. Install npm (Node Package Manager):
```bash
sudo apt install npm -y
```

3. Install corepack globally:
```bash
sudo npm install -g corepack
```

4. Enable `pnpm` using corepack:
```bash
corepack enable pnpm
```
<br/><br/>

---

### Step 3: Build process and OpenCloud initialization

1. Navigate to the OpenCloud directory:
```bash
cd opencloud
```

2. Run the generate process:
```bash
make clean generate
```

3. Build OpenCloud:
```bash
make clean build
```

4. Initialize OpenCloud with insecure configuration and set an admin password:
```bash
./bin/opencloud init --insecure true --admin-password admin
```

5. Start the OpenCloud server:
```bash
./bin/opencloud server
```
<br/><br/>

---

### 4. Login

Login with your browser:
- [https://cloud.opencloud.test](https://cloud.opencloud.test)
- user: **admin**
- password: **admin**

Congratulations! You’ve successfully set up and launched OpenCloud! Happy hacking!

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

---

### Conclusion

Your OpenCloud server is now running and ready to use 🚀
Binary file added docs/admin/installation/img/bare-metal/login.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.