Commit f32ab8ae authored by Bekerle, Patrizio's avatar Bekerle, Patrizio 🔥
Browse files

Add more documentation and links

parent eef5ca18
# WebAppPassword Change Log
## 20.8.2
- Add more documentation and links
## 20.8.1
- Rename app from `Web App Password` to `WebAppPassword`
......
......@@ -6,7 +6,7 @@
This is a Nextcloud app to generate a temporary app password and set CORS headers to allow
WebDAV access from inside a webpage.
Place this app in **nextcloud/apps/**
Place this app in **nextcloud/apps/** or install it from the [Nextcloud App Store](https://apps.nextcloud.com/apps/webapppassword).
## Configuration
......@@ -24,8 +24,13 @@ for the referrer check whether we want to generate a temporary app password.
## Docker
* `cd docker`
* `docker-compose up`
You can use this container for development and testing of the application.
```bash
cd docker
docker-compose up
```
* <http://localhost:8081> admin/admin
* (first time only) For the origin config see `WEBPASSWORD_ORIGINS` in docker-compose.yml
......@@ -57,29 +62,6 @@ 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)
## Deploying to the Nextcloud app store
### Prerequisites
- Copy your app certificate files to `./docker/nextcloud/certificates`
- Take a look at [webapppassword.md](https://gitlab.tugraz.at/vpu-private/vpu-docs-private/-/blob/master/docs/projects/webapppassword.md)
on how to get the files
### Signing and releasing
- Make sure the version in `appinfo/info.xml` and the `CHANGELOG.md` are updated
- Sign the app with `cd docker && make sign-app`
- You should now have a `webapppassword.tar.gz` in your git directory
- Check the content of the archive for unwanted files (you can exclude more files in
`docker/nextcloud/sign-app.sh`)
- Create a new release on [WebAppPassword releases](https://gitlab.tugraz.at/dbp/nextcloud/webapppassword/-/releases/)
with the version like `v20.8.0` as *Tag name* and the changelog text of the current release as *Release notes*
- You also need to upload `webapppassword.tar.gz` to the *Release notes* of the release and get its url
- Take the text from *Signature for your app archive*, which was printed by the sign-app command and
release the app at [Upload app release](https://apps.nextcloud.com/developer/apps/releases/new)
- You need the download link to `webapppassword.tar.gz` from the GitLab release
- The new version should then appear on the [WebAppPassword store page](https://apps.nextcloud.com/apps/webapppassword)
## References
This Nextcloud application is used in the
......
......@@ -4,15 +4,24 @@
<id>webapppassword</id>
<name>WebAppPassword</name>
<summary>Temporary app password generator</summary>
<description><![CDATA[Temporary app password generator and WebDAV CORS header injection to be able access the Nextcloud WebDAV service from inside web applications.]]></description>
<version>20.8.1</version>
<description><![CDATA[Temporary app password generator and WebDAV CORS header injection to be able access the
Nextcloud WebDAV service from inside web applications.
There is an [example implementation](https://gitlab.tugraz.at/dbp/nextcloud/webapppassword/-/blob/master/index.html)
that uses this app to generate a temporary password and make a WebDAV request to a Nextcloud instance
([docker container](https://gitlab.tugraz.at/dbp/nextcloud/webapppassword/-/tree/master/docker) included).]]></description>
<version>20.8.2</version>
<licence>agpl</licence>
<author mail="patrizio.bekerle@tugraz.at">Patrizio Bekerle</author>
<namespace>WebAppPassword</namespace>
<types>
<dav />
</types>
<documentation>
<admin>https://gitlab.tugraz.at/dbp/nextcloud/webapppassword</admin>
</documentation>
<category>security</category>
<website>https://gitlab.tugraz.at/dbp/nextcloud/webapppassword</website>
<bugs>https://gitlab.tugraz.at/dbp/nextcloud/webapppassword/-/issues</bugs>
<repository type="git">https://gitlab.tugraz.at/dbp/nextcloud/webapppassword.git</repository>
<screenshot>https://gitlab.tugraz.at/dbp/nextcloud/webapppassword/-/raw/master/screenshot.png</screenshot>
......
......@@ -11,17 +11,17 @@ login to your Nextcloud instance.
## Check nextcloud.log
In case the whole site is broken you can do a:
For debugging you can show the `nextcloud.log`:
```bash
make show-log
```
For other errors you can watch <http://localhost:8081/index.php/settings/admin/logging>.
There also is a [loggin web interface](http://localhost:8081/index.php/settings/admin/logging).
## Tip
In case something is broken try to reset things:
In case something is broken try to reset the container:
```bash
docker-compose build; docker-compose down; docker volume prune -f
......
# Deploying to the Nextcloud app store
## Prerequisites
- Copy your app certificate files to `./docker/nextcloud/certificates`
- Take a look at [webapppassword.md](https://gitlab.tugraz.at/vpu-private/vpu-docs-private/-/blob/master/docs/projects/webapppassword.md)
on how to get the files
### Signing and releasing
- Make sure the version in `appinfo/info.xml` and the `CHANGELOG.md` are updated
- Sign the app with `cd docker && make sign-app`
- You should now have a `webapppassword.tar.gz` in your git directory
- Check the content of the archive for unwanted files (you can exclude more files in
`docker/nextcloud/sign-app.sh`)
- Create a new release on [WebAppPassword releases](https://gitlab.tugraz.at/dbp/nextcloud/webapppassword/-/releases/)
with the version like `v20.8.0` as *Tag name* and the changelog text of the current release as *Release notes*
- You also need to upload `webapppassword.tar.gz` to the *Release notes* of the release and get its url
- Take the text from *Signature for your app archive*, which was printed by the sign-app command and
release the app at [Upload app release](https://apps.nextcloud.com/developer/apps/releases/new)
- You need the download link to `webapppassword.tar.gz` from the GitLab release
- The new version should then appear on the [WebAppPassword store page](https://apps.nextcloud.com/apps/webapppassword)
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment