mirror/opencloud
1
0
Fork 0
mirror of https://github.com/opencloud-eu/opencloud.git synced 2025-12-23 22:29:59 -05:00
Code Issues Packages Projects Releases Wiki Activity

url fixes, more decisions

Browse Source 
Signed-off-by: Jörn Friedrich Dreyer <jfd@butonic.de>
This commit is contained in:
Jörn Friedrich Dreyer
2025-01-29 16:49:39 +01:00
parent d8e6e3330f
commit 8ac250952f
28 changed files with 37 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
CONTRIBUTING.md
View File

@@ -150,7 +150,7 @@ All contributions to OpenClouds projects use so-called pull requests following t
Please follow these steps to have your contribution considered by the maintainers:
* Follow all instructions in [the template](https://github.com/opencloud-eu/opencloud/blob/master/.github/pull_request_template.md)
* Follow all instructions in [the template](https://github.com/opencloud-eu/opencloud/blob/main/.github/pull_request_template.md)
* Follow the [styleguides](#styleguides) where applicable
* After you submit your pull request, verify that all [status checks](https://help.github.com/articles/about-status-checks/) are passing <details><summary>What if the status checks are failing?</summary>If a status check is failing, and you believe that the failure is unrelated to your change, please leave a comment on the pull request explaining why you believe the failure is unrelated. A maintainer will re-run the status check for you. If we conclude that the failure was a false positive, then we will open an issue to track that problem with our status check suite.</details>

2
README.md
View File

@@ -37,7 +37,7 @@ That will produce the binary `opencloud/bin/opencloud`.
For more information consult the [Development Documentation](https://docs.opencloud.eu/opencloud/).
Please always refer to our [Contribution Guidelines](https://github.com/opencloud-eu/opencloud/blob/master/CONTRIBUTING.md).
Please always refer to our [Contribution Guidelines](https://github.com/opencloud-eu/opencloud/blob/main/CONTRIBUTING.md).
## Security

2
protogen/gen/opencloud/services/eventhistory/v0/eventhistory.swagger.json
View File

@@ -10,7 +10,7 @@
},
"license": {
"name": "Apache-2.0",
"url": "https://github.com/opencloud-eu/opencloud/blob/master/LICENSE"
"url": "https://github.com/opencloud-eu/opencloud/blob/main/LICENSE"
}
},
"tags": [

2
protogen/gen/opencloud/services/policies/v0/policies.swagger.json
View File

@@ -10,7 +10,7 @@
},
"license": {
"name": "Apache-2.0",
"url": "https://github.com/opencloud-eu/opencloud/blob/master/LICENSE"
"url": "https://github.com/opencloud-eu/opencloud/blob/main/LICENSE"
}
},
"tags": [

2
protogen/gen/opencloud/services/search/v0/search.swagger.json
View File

@@ -10,7 +10,7 @@
},
"license": {
"name": "Apache-2.0",
"url": "https://github.com/opencloud-eu/opencloud/blob/master/LICENSE"
"url": "https://github.com/opencloud-eu/opencloud/blob/main/LICENSE"
}
},
"tags": [

2
protogen/gen/opencloud/services/settings/v0/settings.swagger.json
View File

@@ -10,7 +10,7 @@
},
"license": {
"name": "Apache-2.0",
"url": "https://github.com/opencloud-eu/opencloud/blob/master/LICENSE"
"url": "https://github.com/opencloud-eu/opencloud/blob/main/LICENSE"
}
},
"tags": [

2
protogen/gen/opencloud/services/store/v0/store.swagger.json
View File

@@ -10,7 +10,7 @@
},
"license": {
"name": "Apache-2.0",
"url": "https://github.com/opencloud-eu/opencloud/blob/master/LICENSE"
"url": "https://github.com/opencloud-eu/opencloud/blob/main/LICENSE"
}
},
"tags": [

2
protogen/gen/opencloud/services/thumbnails/v0/thumbnails.swagger.json
View File

@@ -10,7 +10,7 @@
},
"license": {
"name": "Apache-2.0",
"url": "https://github.com/opencloud-eu/opencloud/blob/master/LICENSE"
"url": "https://github.com/opencloud-eu/opencloud/blob/main/LICENSE"
}
},
"tags": [

2
protogen/proto/opencloud/services/eventhistory/v0/eventhistory.proto
View File

@@ -19,7 +19,7 @@ option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
};
license: {
name: "Apache-2.0";
url: "https://github.com/opencloud-eu/opencloud/blob/master/LICENSE";
url: "https://github.com/opencloud-eu/opencloud/blob/main/LICENSE";
};
};
schemes: HTTP;

2
protogen/proto/opencloud/services/policies/v0/policies.proto
View File

@@ -19,7 +19,7 @@ option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
};
license: {
name: "Apache-2.0";
url: "https://github.com/opencloud-eu/opencloud/blob/master/LICENSE";
url: "https://github.com/opencloud-eu/opencloud/blob/main/LICENSE";
};
};
schemes: HTTP;

2
protogen/proto/opencloud/services/search/v0/search.proto
View File

@@ -21,7 +21,7 @@ option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
};
license: {
name: "Apache-2.0";
url: "https://github.com/opencloud-eu/opencloud/blob/master/LICENSE";
url: "https://github.com/opencloud-eu/opencloud/blob/main/LICENSE";
};
};
schemes: HTTP;

2
protogen/proto/opencloud/services/settings/v0/settings.proto
View File

@@ -20,7 +20,7 @@ option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
};
license: {
name: "Apache-2.0";
url: "https://github.com/opencloud-eu/opencloud/blob/master/LICENSE";
url: "https://github.com/opencloud-eu/opencloud/blob/main/LICENSE";
};
};
schemes: HTTP;

2
protogen/proto/opencloud/services/store/v0/store.proto
View File

@@ -18,7 +18,7 @@ option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
};
license: {
name: "Apache-2.0";
url: "https://github.com/opencloud-eu/opencloud/blob/master/LICENSE";
url: "https://github.com/opencloud-eu/opencloud/blob/main/LICENSE";
};
};
schemes: HTTP;

2
protogen/proto/opencloud/services/thumbnails/v0/thumbnails.proto
View File

@@ -18,7 +18,7 @@ option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
};
license: {
name: "Apache-2.0";
url: "https://github.com/opencloud-eu/opencloud/blob/master/LICENSE";
url: "https://github.com/opencloud-eu/opencloud/blob/main/LICENSE";
};
};
schemes: HTTP;

2
services/antivirus/README.md
View File

@@ -55,7 +55,7 @@ The antivirus service can scan files during `postprocessing`. `on demand` scanni
### Postprocessing
The antivirus service will scan files during postprocessing. It listens for a postprocessing step called `virusscan`. This step can be added in the environment variable `POSTPROCESSING_STEPS`. Read the documentation of the [postprocessing service](https://github.com/opencloud-eu/opencloud/tree/master/services/postprocessing) for more details.
The antivirus service will scan files during postprocessing. It listens for a postprocessing step called `virusscan`. This step can be added in the environment variable `POSTPROCESSING_STEPS`. Read the documentation of the [postprocessing service](https://github.com/opencloud-eu/opencloud/tree/main/services/postprocessing) for more details.
The number of concurrent scans can be increased by setting `ANTIVIRUS_WORKERS`, but be aware that this will also increase the memory usage.

2
services/app-registry/README.md
View File

@@ -12,7 +12,7 @@ Administrators can set default applications for each MIME type and also allow th
### MIME Type Configuration
Modifing the MIME type config can only be achieved via a yaml configuration. Using environment variables is not possible. For an example, see the `opencloud_full/config/opencloud/app-registry.yaml` at [docker-compose example](https://github.com/opencloud-eu/opencloud/tree/master/deployments/examples). The following is a brief structure and a field description:
Modifing the MIME type config can only be achieved via a yaml configuration. Using environment variables is not possible. For an example, see the `opencloud_full/config/opencloud/app-registry.yaml` at [docker-compose example](https://github.com/opencloud-eu/opencloud/tree/main/deployments/examples). The following is a brief structure and a field description:
**Structure**

2
services/auth-bearer/README.md
View File

@@ -13,7 +13,7 @@ OpenCloud uses serveral authentication services for different use cases. All ser
## Built in OpenID Connect Identity Provider
A default OpenCloud deployment will start a [built in OpenID Connect identity provider](https://github.com/opencloud-eu/opencloud/tree/master/services/idp) but can be configured to use an external one as well.
A default OpenCloud deployment will start a [built in OpenID Connect identity provider](https://github.com/opencloud-eu/opencloud/tree/main/services/idp) but can be configured to use an external one as well.
## Scalability

2
services/frontend/README.md
View File

@@ -20,7 +20,7 @@ The datagateway endpoint, by default `/data`, forwards file up- and download req
### ocs
The ocs endpoint, by default `/ocs`, implements the ownCloud 10 Open Collaboration Services API by translating it into CS3 API requests. It can handle users, groups, capabilities and also implements the files sharing functionality on top of CS3. The `/ocs/v[12].php/cloud/user/signing-key` is currently handled by the dedicated [ocs](https://github.com/opencloud-eu/opencloud/tree/master/services/ocs) service.
The ocs endpoint, by default `/ocs`, implements the Open Collaboration Services API by translating it into CS3 API requests. It can handle users, groups, capabilities and also implements the files sharing functionality on top of CS3. The `/ocs/v[12].php/cloud/user/signing-key` is currently handled by the dedicated [ocs](https://github.com/opencloud-eu/opencloud/tree/main/services/ocs) service.
#### Event Handler

2
services/invitations/README.md
View File

@@ -19,7 +19,7 @@ The default and currently only available backend used to handle invitations is [
<!--- Note that the link below must be an absolute URL and not a relative file path --->
See the [example configuration json file](https://github.com/opencloud-eu/opencloud/blob/master/services/invitations/md-sources/example-realm.json) of a Keycloak realm the backend will work with. This file includes the `invitations` client, which is relevant for this service.
See the [example configuration json file](https://github.com/opencloud-eu/opencloud/blob/main/services/invitations/md-sources/example-realm.json) of a Keycloak realm the backend will work with. This file includes the `invitations` client, which is relevant for this service.
To use the example json, set the `INVITATIONS_KEYCLOAK_CLIENT_ID` setting to `invitations`, though any other client ID can be configured.

2
services/invitations/pkg/service/v0/service.go
View File

@@ -11,7 +11,7 @@ import (
)
const (
OwnCloudInstanceRel = "http://invitations.owncloud/rel/server-instance"
OwnCloudInstanceRel = "http://invitations.opencloud/rel/server-instance"
OpenIDConnectRel = "http://openid.net/specs/connect/1.0/issuer"
)

6
services/notifications/README.md
View File

@@ -23,10 +23,10 @@ In addition, the notifications service supports custom templates. Custom email t
{NOTIFICATIONS_EMAIL_TEMPLATE_PATH}/templates/html/email.html.tmpl
{NOTIFICATIONS_EMAIL_TEMPLATE_PATH}/templates/html/img/
```
The source templates provided by OpenCloud you can derive from are located in the following base folder [https://github.com/opencloud-eu/opencloud/tree/master/services/notifications/pkg/email/templates](https://github.com/opencloud-eu/opencloud/tree/master/services/notifications/pkg/email/templates) with subfolders `templates/text` and `templates/html`.
The source templates provided by OpenCloud you can derive from are located in the following base folder [https://github.com/opencloud-eu/opencloud/tree/main/services/notifications/pkg/email/templates](https://github.com/opencloud-eu/opencloud/tree/main/services/notifications/pkg/email/templates) with subfolders `templates/text` and `templates/html`.
- [text/email.text.tmpl](https://github.com/opencloud-eu/opencloud/blob/master/services/notifications/pkg/email/templates/text/email.text.tmpl)
- [html/email.html.tmpl](https://github.com/opencloud-eu/opencloud/blob/master/services/notifications/pkg/email/templates/html/email.html.tmpl)
- [text/email.text.tmpl](https://github.com/opencloud-eu/opencloud/blob/main/services/notifications/pkg/email/templates/text/email.text.tmpl)
- [html/email.html.tmpl](https://github.com/opencloud-eu/opencloud/blob/main/services/notifications/pkg/email/templates/html/email.html.tmpl)
### Templates subfolder hierarchy
```text

4
services/policies/README.md
View File

@@ -136,7 +136,7 @@ Note that additional steps can be configured and their position in the list defi
## Rego Key Match
To identify available keys for OPA, you need to look at [engine.go](https://github.com/opencloud-eu/opencloud/blob/master/services/policies/pkg/engine/engine.go) and the [policies.swagger.json](https://github.com/opencloud/blob/blob/master/protogen/gen/opencloud/services/policies/v0/policies.swagger.json) file. Note that which keys are available depends on from which module it is used.
To identify available keys for OPA, you need to look at [engine.go](https://github.com/opencloud-eu/opencloud/blob/main/services/policies/pkg/engine/engine.go) and the [policies.swagger.json](https://github.com/opencloud/blob/blob/master/protogen/gen/opencloud/services/policies/v0/policies.swagger.json) file. Note that which keys are available depends on from which module it is used.
## Extend Mimetype File Extension Mapping
@@ -164,4 +164,4 @@ A good example of how such a file should be formatted can be found in the [Apach
## Example Policies
The policies service contains a set of preconfigured example policies. See the [deployment examples](https://github.com/opencloud-eu/opencloud/tree/master/deployments/examples) directory for details. The contained policies disallow OpenCloud to create certain file types, both via the proxy middleware and the events service via postprocessing.
The policies service contains a set of preconfigured example policies. See the [deployment examples](https://github.com/opencloud-eu/opencloud/tree/main/deployments/examples) directory for details. The contained policies disallow OpenCloud to create certain file types, both via the proxy middleware and the events service via postprocessing.

4
services/proxy/README.md
View File

@@ -15,7 +15,7 @@ The following request authentication schemes are implemented:
## Configuring Routes
The proxy handles routing to all endpoints that OpenCloud offers. The currently availabe default routes can be found [in the code](https://github.com/opencloud-eu/opencloud/blob/master/services/proxy/pkg/config/defaults/defaultconfig.go). Changing or adding routes can be necessary when writing own OpenCloud extensions.
The proxy handles routing to all endpoints that OpenCloud offers. The currently availabe default routes can be found [in the code](https://github.com/opencloud-eu/opencloud/blob/main/services/proxy/pkg/config/defaults/defaultconfig.go). Changing or adding routes can be necessary when writing own OpenCloud extensions.
Due to the complexity when defining routes, these can only be defined in the yaml file but not via environment variables.
@@ -237,7 +237,7 @@ For OpenCloud, external resources like an IDP (e.g. Keycloak) or when using web
To create a Content Security Policy (CSP), you need to create a yaml file containing the CSP definitions. To activate the settings, reference the file as value in the `PROXY_CSP_CONFIG_FILE_LOCATION` environment variable. For each change, a restart of the OpenCloud deployment or the proxy service is required.
A working example for a CSP can be found in a sub path of the `config` directory of the [opencloud_full](https://github.com/opencloud-eu/opencloud/tree/master/deployments/examples/opencloud_full/config) deployment example.
A working example for a CSP can be found in a sub path of the `config` directory of the [opencloud_full](https://github.com/opencloud-eu/opencloud/tree/main/deployments/examples/opencloud_full/config) deployment example.
See the [Content Security Policy (CSP) Quick Reference Guide](https://content-security-policy.com) for a description of directives.

4
services/search/README.md
View File

@@ -39,7 +39,7 @@ Not all parts are supported, the following list gives an overview of parts that
* NEAR operator
* Date intervals
In the following [ADR](https://github.com/opencloud-eu/opencloud/blob/docs/ocis/adr/0020-file-search-query-language.md) you can read why we chose KQL.
In [this ADR](https://github.com/owncloud/ocis/blob/docs/ocis/adr/0020-file-search-query-language.md) you can read why KQL whas chosen.
## Extraction Engines
@@ -74,7 +74,7 @@ When extracting content, you can specify whether [stop words](https://en.wikiped
When using the Tika container and docker-compose, consider the following:
* See the [opencloud_full](https://github.com/opencloud-eu/opencloud/tree/master/deployments/examples/opencloud_full) example.
* See the [opencloud_full](https://github.com/opencloud-eu/opencloud/tree/main/deployments/examples/opencloud_full) example.
* Containers for the linked service are reachable at a hostname identical to the alias or the service name if no alias was specified.
If using the `tika` extractor, make sure to also set `FRONTEND_FULL_TEXT_SEARCH_ENABLED` in the frontend service to `true`. This will tell the webclient that full-text search has been enabled.

4
services/webdav/README.md
View File

@@ -10,13 +10,13 @@ Currently, the webdav service handles request for two functionalities, which are
The webdav service provides various `GET` endpoints to get the thumbnails of a file in authenticated and unauthenticated contexts. It also provides thumbnails for spaces on different endpoints.
See the [thumbnail](https://github.com/opencloud-eu/opencloud/tree/master/services/thumbnails) service for more information about thumbnails.
See the [thumbnail](https://github.com/opencloud-eu/opencloud/tree/main/services/thumbnails) service for more information about thumbnails.
### Search
The webdav service provides access to the search functionality. It offers multiple `REPORT` endpoints for getting search results.
See the [search](https://github.com/opencloud-eu/opencloud/tree/master/services/search) service for more details about search functionality.
See the [search](https://github.com/opencloud-eu/opencloud/tree/main/services/search) service for more details about search functionality.
## Scalability

6
tests/README.md
View File

@@ -14,8 +14,8 @@ make -C tests/acceptance/docker help
Basically we have two sources for feature tests and test suites:
- [OpenCloud feature test and test suites](https://github.com/opencloud-eu/opencloud/tree/master/tests/acceptance/features)
- [tests and test suites transferred from core, they have prefix coreApi](https://github.com/opencloud-eu/opencloud/tree/master/tests/acceptance/features)
- [OpenCloud feature test and test suites](https://github.com/opencloud-eu/opencloud/tree/main/tests/acceptance/features)
- [tests and test suites transferred from core, they have prefix coreApi](https://github.com/opencloud-eu/opencloud/tree/main/tests/acceptance/features)
At the moment, both can be applied to OpenCloud.
@@ -30,7 +30,7 @@ You can invoke two types of test suite runs:
#### Local OpenCloud Tests (prefix `api`)
The names of the full test suite make targets have the same naming as in the CI pipeline. See the available local OpenCloud specific test suites [here](https://github.com/opencloud-eu/opencloud/tree/master/tests/acceptance/features). They can be run with `decomposed` storage and `decomposed_s3` storage.
The names of the full test suite make targets have the same naming as in the CI pipeline. See the available local OpenCloud specific test suites [here](https://github.com/opencloud-eu/opencloud/tree/main/tests/acceptance/features). They can be run with `decomposed` storage and `decomposed_s3` storage.
For example, command:

4
tests/acceptance/docker/Makefile
View File

@@ -56,10 +56,10 @@ help:
@echo -e "${PURPLE}docs: https://docs.opencloud.eu/opencloud/development/testing/#testing-with-test-suite-in-docker${RESET}\n"
@echo
@echo -e "OpenCloud feature tests and test suites can be found here:"
@echo -e "\thttps://github.com/opencloud-eu/opencloud/tree/master/tests/acceptance/features"
@echo -e "\thttps://github.com/opencloud-eu/opencloud/tree/main/tests/acceptance/features"
@echo
@echo -e "test suites that test core compatibility are found here and they start with prefix coreApi-:"
@echo -e "\thttps://github.com/opencloud-eu/opencloud/tree/master/tests/acceptance/features"
@echo -e "\thttps://github.com/opencloud-eu/opencloud/tree/main/tests/acceptance/features"
@echo
@echo -e "The OpenCloud to be tested will be build from your current working state."
@echo -e "You also can select the OpenCloud Docker image for all tests by setting"

2
tests/acceptance/docker/src/opencloud-base.yml
View File

@@ -24,7 +24,7 @@ services:
OC_ASYNC_UPLOADS: $OC_ASYNC_UPLOADS
OC_ADD_RUN_SERVICES: $OC_ADD_RUN_SERVICES
PROXY_HTTP_ADDR: "0.0.0.0:9200"
OC_JWT_SECRET: "some-ocis-jwt-secret"
OC_JWT_SECRET: "some-random-jwt-secret"
# s3ng specific settings
STORAGE_USERS_S3NG_ENDPOINT: http://ceph:8080