Skip to content

Commit 5ee771a

Browse files
authored
chore: update readme (#27)
1 parent 9942193 commit 5ee771a

File tree

1 file changed

+4
-56
lines changed

1 file changed

+4
-56
lines changed

README.md

Lines changed: 4 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -11,59 +11,7 @@ This repository contains a collection of [ownCloud Web](https://github.com/owncl
1111

1212
Extensions are provided by apps. These are the apps, that are provided by this repository.
1313

14-
## [web-app-cast](./packages/web-app-cast/)
15-
16-
This app enables Google Cast integration for ownCloud Web.
17-
18-
## Usage instructions
19-
20-
There is a docker image hosted on [Docker Hub](https://registry.hub.docker.com/r/owncloud/web-extensions).
21-
It serves compiled assets statically.
22-
23-
This is the list of available app paths provided by the service:
24-
25-
```
26-
/extensions/cast/cast.js
27-
```
28-
29-
### ocis_traefik
30-
31-
If you want to deploy web-extensions to the [ocis_traefik](https://github.com/owncloud/ocis/tree/master/deployments/examples/ocis_traefik) example, you need to add a service like this to the `docker-compose.yml` file.
32-
33-
```yaml
34-
web-extensions:
35-
image: owncloud/web-extensions:latest
36-
networks:
37-
ocis-net:
38-
labels:
39-
- "traefik.enable=true"
40-
- "traefik.http.routers.web-extensions.entrypoints=https"
41-
- "traefik.http.routers.web-extensions.rule=Host(`${OCIS_DOMAIN:-ocis.owncloud.test}`) && PathPrefix(`/extensions`)"
42-
- "traefik.http.routers.web-extensions.tls.certresolver=http"
43-
- "traefik.http.routers.web-extensions.service=web-extensions"
44-
- "traefik.http.services.web-extensions.loadbalancer.server.port=8080"
45-
```
46-
47-
You can verify this works correctly by checking `https://ocis.owncloud.test/extensions/cast/cast.js` is a minified javascript file.
48-
49-
Now you can create a `web.config.yaml` file in the `ocis_traefik` folder with the following content. The `cast` app is used as an example here. You need to add a block to the `external_apps` for every app you want to use.
50-
51-
```yaml
52-
web:
53-
config:
54-
external_apps:
55-
- id: cast
56-
path: https://ocis.owncloud.test/extensions/cast/cast.js
57-
```
58-
59-
and mount that to your oCIS container by adding a volume to it like this:
60-
61-
```yaml
62-
ocis:
63-
[...]
64-
volumes:
65-
- ./web.config.yaml:/etc/ocis/web.yaml
66-
[...]
67-
```
68-
69-
If something does not work as expected, you can try to run `docker-compose up --force-recreate` and check again.
14+
- [web-app-cast](./packages/web-app-cast/)
15+
- [web-app-draw-io](./packages/web-app-draw-io/)
16+
- [web-app-external-sites](./packages/web-app-external-sites/)
17+
- [web-app-progress-bars](./packages/web-app-progress-bars/)

0 commit comments

Comments
 (0)