MirrorMirror
/
funkwhale
mirror of https://dev.funkwhale.audio/funkwhale/funkwhale.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs(developer/setup/docker): move documentation section up to the other set up instructions 

[skip ci]
This commit is contained in:
jon r 2025-04-04 14:14:53 +02:00
parent 6bab72091c
commit 4aa9e382c4
1 changed files with 15 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
docs/developer/setup/docker.md
View File

@ -281,6 +281,21 @@ The generated tracks do not contain any audio and are here for testing purposes
Read about [seeding additional instances](#seeding-additional-instances) below.
## Set up local documentation
To build the documentation locally run:
```sh
docker compose -f compose.docs.yml up -d
```
The documentation is then accessible at <https://docs.funkwhale.test>. The OpenAPI schema is available at <https://openapi.funkwhale.test>. The UI component library will be served at <https://ui.funkwhale.test>.
Fallback ports are available for the documentation at <http://localhost:8001/>, for the OpenAPI schema at <http://localhost:8002/> and for the UI component library at <http://localhost:8003/>.
Maintain their life cycle with similar commands to those used to
[set up network services (point 2.)](#set-up-network-services).
## Lifecycle
Recycle individual containers:
@ -472,27 +487,6 @@ This step does not apply to the default instance when running `docker compose` w
In this case follow the manual steps from above. First create a super user as described in [set up application services](#set-up-application-services) and then continue with the [set up of local data for development](#set-up-local-data-for-development).
```
## Local documentation
To build the documentation locally run:
```sh
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 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/), 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 network services (point 2.)](#set-up-network-services).
The documentation is then accessible at <https://docs.funkwhale.test>. The OpenAPI schema is available at <https://openapi.funkwhale.test>. The UI component library will be served at <https://ui.funkwhale.test>.
Fallback ports are available for the documentation at <http://localhost:8001/>, for the OpenAPI schema at <http://localhost:8002/> and for the UI component library at <http://localhost:8003/>.
## Running the test suites
Run the App test suite: