diff --git a/docs/admin/docker.md b/docs/admin/docker.md new file mode 100644 index 00000000..833151fd --- /dev/null +++ b/docs/admin/docker.md @@ -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 + +Admin general + + +## 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! + +Admin general + +## Common Issues & Help +### Check whether the OpenCloud container is running + +```Shell +docker ps +``` + +Admin general + + +### 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** + +Admin general + +Confirm the risk with **Accept the risk and Contiune** + +Admin general + diff --git a/docs/admin/img/quick-guide/docker-opencloud-init.png b/docs/admin/img/quick-guide/docker-opencloud-init.png new file mode 100644 index 00000000..61e5b83e Binary files /dev/null and b/docs/admin/img/quick-guide/docker-opencloud-init.png differ diff --git a/docs/admin/img/quick-guide/docker-running.png b/docs/admin/img/quick-guide/docker-running.png new file mode 100644 index 00000000..adcd42f1 Binary files /dev/null and b/docs/admin/img/quick-guide/docker-running.png differ diff --git a/docs/admin/quickstart.md b/docs/admin/quickstart.md index c6fb29b0..211fc145 100644 --- a/docs/admin/quickstart.md +++ b/docs/admin/quickstart.md @@ -36,7 +36,7 @@ cd opencloud/deployments/examples/opencloud_full Start the depoyment with Docker Compose: -``` +```Shell docker compose up -d ``` @@ -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** @@ -69,7 +69,7 @@ Congratulations! You’ve successfully set up and launched OpenCloud! Happy hack ### Check whether the containers are running -``` +```Shell docker ps ```