Skip to content

Commit

Permalink
Merge pull request #2357 from rhafer/doc-fixes
Browse files Browse the repository at this point in the history
[docs-only] Add note about remote setup to quickstart
  • Loading branch information
rhafer authored Aug 5, 2021
2 parents 459932c + 07d5dd3 commit 8bd46f2
Show file tree
Hide file tree
Showing 6 changed files with 17 additions and 11 deletions.
4 changes: 2 additions & 2 deletions deployments/examples/ocis_hello/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
document this deployment example in: docs/ocis/deployment/ocis_wopi.md
document this deployment example in: docs/ocis/deployment/ocis_hello.md
---

Please refer to [our documentation](https://owncloud.dev/ocis/deployment/ocis_wopi/)
Please refer to [our documentation](https://owncloud.dev/ocis/deployment/ocis_hello/)
for instructions on how to deploy this scenario.
4 changes: 2 additions & 2 deletions deployments/examples/ocis_s3/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
document this deployment example in: docs/ocis/deployment/ocis_traefik.md
document this deployment example in: docs/ocis/deployment/ocis_s3.md
---

Please refer to [our documentation](https://owncloud.dev/ocis/deployment/ocis_traefik/)
Please refer to [our documentation](https://owncloud.dev/ocis/deployment/ocis_s3/)
for instructions on how to deploy this scenario.
2 changes: 2 additions & 0 deletions docs/ocis/deployment/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ oCIS deployments are super simple, yet there are many configurations possible fo
- [oCIS setup with Traefik for SSL termination]({{< ref "ocis_traefik" >}})
- [oCIS setup with Keycloak as identity provider]({{< ref "ocis_keycloak" >}})
- [oCIS setup with WOPI server to open office documents in your browser]({{< ref "ocis_wopi" >}})
- [oCIS with S3 storage backend (MinIO)]({{< ref "ocis_s3" >}})
- [oCIS with the Hello extension example]({{< ref "ocis_hello" >}})


## Secure an oCIS instance
Expand Down
6 changes: 2 additions & 4 deletions docs/ocis/deployment/ocis_hello.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ date: 2020-10-12T14:04:00+01:00
weight: 24
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs/ocis/deployment
geekdocFilePath: ocis_wopi.md
geekdocFilePath: ocis_hello.md
---

{{< toc >}}
Expand Down Expand Up @@ -42,7 +42,7 @@ See also [example server setup]({{< ref "preparing_server" >}})

- Go to the deployment example

`cd ocis/deployment/examples/ocis_hello
`cd ocis/deployment/examples/ocis_hello`

- Open the `.env` file in a text editor
The file by default looks like this:
Expand Down Expand Up @@ -122,6 +122,4 @@ After that you're ready to start the application stack:

`docker-compose up -d`

Open https://collabora.owncloud.test and https://wopisever.owncloud.test in your browser and accept the invalid certificate warning.

Open https://ocis.owncloud.test in your browser and accept the invalid certificate warning. You are now able to switch to the Hello extension by using the application switcher on the top right corner of ownCloud Web.
6 changes: 3 additions & 3 deletions docs/ocis/deployment/ocis_s3.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ date: 2020-10-12T14:04:00+01:00
weight: 24
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs/ocis/deployment
geekdocFilePath: ocis_wopi.md
geekdocFilePath: ocis_s3.md
---

{{< toc >}}
Expand All @@ -16,7 +16,7 @@ geekdocFilePath: ocis_wopi.md
* oCIS is configured to use S3 as user storage provider
* Traefik generating self signed certificates for local setup or obtaining valid SSL certificates for a server setup

[Find this example on GitHub](https://github.com/owncloud/ocis/tree/master/deployments/examples/ocis_wopi)
[Find this example on GitHub](https://github.com/owncloud/ocis/tree/master/deployments/examples/ocis_s3)

The docker stack consists 3 containers. One of them is Traefik, a proxy which is terminating SSL and forwards the requests to oCIS in the internal docker network.

Expand Down Expand Up @@ -45,7 +45,7 @@ See also [example server setup]({{< ref "preparing_server" >}})

* Go to the deployment example

`cd ocis/deployment/examples/ocis_s3
`cd ocis/deployment/examples/ocis_s3`

* Open the `.env` file in a text editor
The file by default looks like this:
Expand Down
6 changes: 6 additions & 0 deletions docs/ocis/getting-started/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,12 @@ We also have some more variations of oCIS running and [continuously deployed]({{

We are distributing oCIS as binaries and Docker images.

{{< hint warning >}}
The examples in this document assume that oCIS is accessed from the same host as it is running on (`localhost`). If you would like
to access oCIS remotely please refer to the [Basic Remote Setup]({{< ref "../deployment/basic-remote-setup" >}}) section. Especially
to the notes about setting the `PROXY_HTTP_ADDR` and `OCIS_URL` enviroment variables.
{{< /hint >}}

You can find more deployment examples in the [deployment section]({{< ref "../deployment" >}}).

### Binaries
Expand Down

0 comments on commit 8bd46f2

Please sign in to comment.