Merge pull request #395 from nextcloud/enh/noid/windows-docs

add docs on how to run it on windows and improve macOS docs
This commit is contained in:
Simon L 2022-03-19 06:20:59 +01:00 committed by GitHub
commit fe83acd3cc
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -15,6 +15,7 @@ Included are:
**Found a bug?** Please file an issue at https://github.com/nextcloud/all-in-one
## How to use this?
The following instructions are especially meant for Linux. For macOS see [this](#how-to-run-it-on-macos), for Windows see [this](#how-to-run-it-on-windows).
1. Install Docker on your Linux installation using:
```
curl -fsSL get.docker.com | sudo sh
@ -79,7 +80,26 @@ Nextcloud AIO is inspired by projects like Portainer that allow to manage the do
Yes. Please refer to the following documentation on this: [reverse-proxy.md](https://github.com/nextcloud/all-in-one/blob/main/reverse-proxy.md)
### How to run it on macOS?
On macOS, there is one specialty in comparison to linux: instead of using `--volume /var/run/docker.sock:/var/run/docker.sock:ro`, you need to use `--volume /var/run/docker.sock.raw:/var/run/docker.sock:ro`. Apart from that it should work and behave the same like on linux.
On macOS, there is one specialty in comparison to Linux: instead of using `--volume /var/run/docker.sock:/var/run/docker.sock:ro`, you need to use `--volume /var/run/docker.sock.raw:/var/run/docker.sock:ro` to run it after you installed Docker Desktop. Apart from that it should work and behave the same like on Linux.
### How to run it on Windows?
On Windows, the following command should work after you installed Docker Desktop:
<details>
<summary>Click here to show it</summary>
```
docker run -it ^
--name nextcloud-aio-mastercontainer ^
--restart always ^
-p 80:80 ^
-p 8080:8080 ^
-p 8443:8443 ^
--volume nextcloud_aio_mastercontainer:/mnt/docker-aio-config ^
--volume //var/run/docker.sock:/var/run/docker.sock:ro ^
nextcloud/all-in-one:latest
```
</details>
### Which ports are mandatory to be open?
Only those (if you acces the Mastercontainer Interface internally via port 8080):