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
98 changes: 98 additions & 0 deletions docs/admin/docker.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
---
sidebar_position: 3
id: docker
title: Docker
---

# Docker
**Docker**

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


**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/)


---

## 1. Create Required Directories for Bind Mounts

```Shell
mkdir -p $HOME/opencloud/opencloud-config
mkdir -p $HOME/opencloud/opencloud-data
```

## 2. Pull OpenCloud Image

```Shell
docker pull opencloud-eu/opencloud:latest
```

## 3. Initialize OpenCloud (First-time Setup)

```Shell
docker run --rm -it \
-v $HOME/opencloud/opencloud-config:/etc/opencloud \
-v $HOME/opencloud/opencloud-data:/var/lib/opencloud \
-e IDM_ADMIN_PASSWORD=admin \
opencloud-eu/opencloud:latest init
```

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"/>


## 4. Start OpenCloud

```Shell
docker run \
--name opencloud \
--rm \
-it \
-p 9200:9200 \
-v $HOME/opencloud/opencloud-config:/etc/opencloud \
-v $HOME/opencloud/opencloud-data:/var/lib/opencloud \
-e OC_INSECURE=true \
-e PROXY_HTTP_ADDR=0.0.0.0:9200 \
-e OC_URL=https://localhost:9200 \
opencloud-eu/opencloud:latest
```

## 4. Login

Login with your browser:
- [https://localhost:9200](https://localhost:9200)
- user: **admin**
- password: **admin**

Congratulations! You’ve successfully set up and launched OpenCloud! Happy hacking!
Comment thread
AlexAndBear marked this conversation as resolved.

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

## Common Issues & Help
### Check whether the OpenCloud container is running

```Shell
docker ps
```

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


### 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 klick on **Advanced**

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

Confirm the risk with **Accept the risk and Contiune**

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

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/admin/img/quick-guide/docker-running.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 3 additions & 3 deletions docs/admin/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ cd opencloud/deployments/examples/opencloud_full

Start the depoyment with Docker Compose:

```
```Shell
docker compose up -d
```

Expand All @@ -57,7 +57,7 @@ This starts all necessary containers in the background.
## 4. Login

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

Expand All @@ -69,7 +69,7 @@ Congratulations! You’ve successfully set up and launched OpenCloud! Happy hack

### Check whether the containers are running

```
```Shell
docker ps
```

Expand Down