Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/digital-blueprint/webapppassword
Nextcloud app to generate temporary app passwords and allow webdav access for SPAs
https://github.com/digital-blueprint/webapppassword
cors dbp digital-blueprint nextcloud nextcloud-app php webdav
Last synced: about 2 months ago
JSON representation
Nextcloud app to generate temporary app passwords and allow webdav access for SPAs
- Host: GitHub
- URL: https://github.com/digital-blueprint/webapppassword
- Owner: digital-blueprint
- License: agpl-3.0
- Created: 2020-08-06T06:44:13.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-04-08T04:06:28.000Z (9 months ago)
- Last Synced: 2024-04-08T05:23:02.994Z (9 months ago)
- Topics: cors, dbp, digital-blueprint, nextcloud, nextcloud-app, php, webdav
- Language: PHP
- Homepage: https://gitlab.tugraz.at/dbp/nextcloud/webapppassword
- Size: 3.68 MB
- Stars: 16
- Watchers: 4
- Forks: 4
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: COPYING
Awesome Lists containing this project
README
# [WebAppPassword](https://github.com/digital-blueprint/webapppassword)
[Nextcloud App Store](https://apps.nextcloud.com/apps/webapppassword) |
[Releases](https://github.com/digital-blueprint/webapppassword/releases) |
[Old releases](https://gitlab.tugraz.at/dbp/nextcloud/webapppassword/-/releases) |
[Changelog](https://github.com/digital-blueprint/webapppassword/blob/main/CHANGELOG.md) |
[Report issues](https://github.com/digital-blueprint/webapppassword/issues)
[](https://github.com/digital-blueprint/webapppassword/actions/workflows/test.yml)
This is a Nextcloud app to generate a temporary app password and set CORS headers to allow
WebDAV/CalDAV, Share API and Preview access from inside a webpage.
Place this app in **nextcloud/apps/** or install it from the [Nextcloud App Store](https://apps.nextcloud.com/apps/webapppassword).
## Configuration
You can configure the allowed origins for both WebDAV/CalDAV or files sharing api on the settings
page of the application.
Alternatively you can also add this setting to your `config/config.php`
(it will be used if the origins setting on the settings page are empty).
`'webapppassword.origins' => ['https://example.com'],` - array of allowed webdav/caldav origins
The setting is both used for the origin of the CORS headers for the WebDAV/CalDAV requests and
for the referrer check whether we want to generate a temporary app password.
Also, you can configure in the same way the files sharing part.
`'webapppassword.files_sharing_origins' => ['https://example.com'],` - array of allowed files sharing api origins
Under the hood it exposes parts of the sharing api (CRUD and the preflight OPTIONS endpoint) in this url:
`https://example.com/index.php/apps/webapppassword/api/v1/shares`
Also, you can configure in the same way the files preview part.
`'webapppassword.preview_origins' => ['https://example.com'],` - array of allowed preview api origins
Under the hood it exposes parts of the preview api (get and the preflight OPTIONS endpoint) in this url:
`https://example.com/index.php/apps/webapppassword/core/preview`
## Docker
You can use this container for development and testing of the application.
```bash
cd docker
docker compose build
docker compose up
```
* admin/admin
* (first time only) For the origin config see `WEBPASSWORD_ORIGINS` in docker-compose.yml
## Example
You can start a php server with `cd docs/example && php -S localhost:8082` to see an example
page on .
If you have started the docker container you can log in to your Nextcloud container with `admin`/`admin` and
receive a temporary app password for your user.
There also is the `FileSource` component of our [Nextcloud file picker](https://github.com/digital-blueprint/toolkit/tree/main/packages/file-handling)
in the example.
Take a look at [index.html](docs/example/index.html) for the source code of the page.
## Running tests
You can use the provided Makefile to run all tests by using:
```bash
cd docker && make test
```
## Generate translation
You will need the [translationtool](https://github.com/nextcloud/docker-ci/tree/master/translations/translationtool)
to generate the translation files for all languages.
```bash
php /path/to/translationtool.phar convert-po-files
```
See: [Manual translation](https://docs.nextcloud.com/server/19/developer_manual/app/view/l10n.html#manual-translation)
## References
This Nextcloud application is used in the
[NextcloudFilePicker]https://github.com/digital-blueprint/toolkit/blob/main/packages/file-handling/src/nextcloud-file-picker.js)
web component to generate temporary app passwords and to allow WebDAV-access from
inside the web browser.
---
This project is tested with BrowserStack.