diff --git a/compose.docs.yml b/compose.docs.yml index 77e8cd5a9..b8d7f7063 100644 --- a/compose.docs.yml +++ b/compose.docs.yml @@ -5,3 +5,4 @@ networks: include: - path: compose/docs.sphinx.yml - path: compose/docs.openapi.yml + - path: compose/docs.ui.yml diff --git a/compose/docs.ui.yml b/compose/docs.ui.yml new file mode 100644 index 000000000..b230eaaa1 --- /dev/null +++ b/compose/docs.ui.yml @@ -0,0 +1,21 @@ +services: + ui: + build: + context: ../front + dockerfile: Dockerfile.dev + command: yarn dev:docs --host 0.0.0.0 + expose: ["5173"] + ports: + - "8003:5173" + volumes: + - "../front:/app" + - "/app/node_modules" + networks: ["web"] + labels: + - "traefik.enable=true" + - "traefik.http.routers.test-funkwhale-ui-web.rule=Host(`ui.funkwhale.test`)" + - "traefik.http.routers.test-funkwhale-ui-web.entrypoints=web" + - "traefik.http.services.test-funkwhale-ui.loadbalancer.server.port=5173" + - "traefik.http.routers.test-funkwhale-ui-webs.rule=Host(`ui.funkwhale.test`)" + - "traefik.http.routers.test-funkwhale-ui-webs.entrypoints=webs" + - "traefik.http.routers.test-funkwhale-ui-webs.tls=true" diff --git a/docs/developer/setup/docker.md b/docs/developer/setup/docker.md index a0ffc1e55..c0c122229 100644 --- a/docs/developer/setup/docker.md +++ b/docs/developer/setup/docker.md @@ -416,11 +416,11 @@ To build the documentation locally run: docker compose -f compose.docs.yml up -d ``` -The documentation is then accessible at [https://docs.funkwhale.test](https://docs.funkwhale.test). The OpenAPI schema is available at [https://openapi.funkwhale.test](https://openapi.funkwhale.test). +The documentation is then accessible at [https://docs.funkwhale.test](https://docs.funkwhale.test). The OpenAPI schema is available at [https://openapi.funkwhale.test](https://openapi.funkwhale.test). The UI component library is available at [https://ui.funkwhale.test](https://ui.funkwhale.test). Fallback ports are available for the documentation at -[http://localhost:8001/](http://localhost:8001/) and for the OpenAPI schema at -[http://localhost:8002/](http://localhost:8002/). +[http://localhost:8001/](http://localhost:8001/), for the OpenAPI schema at +[http://localhost:8002/](http://localhost:8002/) and for the UI component library at [http://localhost:8003/](http://localhost:8003/). Maintain their life cycle with similar commands to those used to [set up auxiliary services (point 2.)](#set-up-auxiliary-services).