pyrox.dev
1# OpenCloud {#module-services-opencloud}
2
3[OpenCloud](https://opencloud.eu/en) is an open-source, modern file-sync and
4sharing platform. It is a fork of oCIS, a ground-up rewrite of the well-known
5PHP-based NextCloud server.
6
7The service can be configured using a combination of [](#opt-services.opencloud.settings),
8[](#opt-services.opencloud.environment) and [](#opt-services.opencloud.environmentFile).
9
10## Basic usage {#module-services-opencloud-basic-usage}
11
12OpenCloud is configured using a combination of YAML and environment
13variables. The full documentation can be found at
14[OpenCloud Admin Docs](https://docs.opencloud.eu/docs/admin/intro).
15
16The general flow of configuring OpenCloud is:
17- configure services with `services.opencloud.settings.<service>` when possible
18- configure global settings that affect multiple services via `services.opencloud.environment`
19- allow NixOS to provision a default `opencloud.yaml` for you, containing default credentials
20 for communication between the microservices
21- provide additional secrets via `environmentFile`, provisioned out of band
22
23Please note that current NixOS module for OpenCloud is configured to run in
24`fullstack` mode, which starts all the services for OpenCloud in a single
25instance, in so called supervised mode. This will start multiple OpenCloud
26services and listen on multiple other ports.
27
28Current known services and their ports are as below:
29
30| Service | Group | Port |
31|--------------------|---------|-------|
32| gateway | api | 9142 |
33| sharing | api | 9150 |
34| app-registry | api | 9242 |
35| ocdav | web | 45023 |
36| auth-machine | api | 9166 |
37| storage-system | api | 9215 |
38| webdav | web | 9115 |
39| webfinger | web | 46871 |
40| storage-system | web | 9216 |
41| web | web | 9100 |
42| eventhistory | api | 33177 |
43| ocs | web | 9110 |
44| storage-publiclink | api | 9178 |
45| settings | web | 9190 |
46| ocm | api | 9282 |
47| settings | api | 9191 |
48| ocm | web | 9280 |
49| app-provider | api | 9164 |
50| storage-users | api | 9157 |
51| auth-service | api | 9199 |
52| thumbnails | web | 9186 |
53| thumbnails | api | 9185 |
54| storage-shares | api | 9154 |
55| sse | sse | 46833 |
56| userlog | userlog | 45363 |
57| search | api | 9220 |
58| proxy | web | 9200 |
59| idp | web | 9130 |
60| frontend | web | 9140 |
61| groups | api | 9160 |
62| graph | graph | 9120 |
63| users | api | 9144 |
64| auth-basic | api | 9146 |