mirrors/PairDrop
1
0
Fork 0
mirror of https://github.com/schlagmichdoch/PairDrop.git synced 2025-04-20 07:05:05 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Change docs to reflect that dev files are now included in master branch

Browse source
This commit is contained in:
schlagmichdoch 2024-07-13 21:50:08 +02:00
parent fa24e77d3b
commit 331c61fec8
1 changed files with 20 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

29
docs/host-your-own.md
View file

@ -656,19 +656,19 @@ To run PairDrop including its own coturn-server you need to punch holes in the f
### Install ### Install
All files needed for developing are available on the branch `dev`. All files needed for developing are available in the folder `./dev`.
First, [Install docker with docker-compose.](https://docs.docker.com/compose/install/) For convenience, there is also a docker compose file for developing:
Then, clone the repository and run docker-compose: #### Developing with docker compose
First, [Install docker with docker compose.](https://docs.docker.com/compose/install/)
Then, clone the repository and run docker compose:
```bash ```bash
git clone https://github.com/schlagmichdoch/PairDrop.git && cd PairDrop git clone https://github.com/schlagmichdoch/PairDrop.git && cd PairDrop
``` ```
```bash ```bash
git checkout dev
```
```bash
docker compose -f docker-compose-dev.yml up --no-deps --build docker compose -f docker-compose-dev.yml up --no-deps --build
``` ```
@ -679,7 +679,7 @@ Now point your web browser to `http://localhost:8080`.
<br> <br>
### Testing PWA related features #### Testing PWA related features
PWAs requires the app to be served under a correctly set up and trusted TLS endpoint. PWAs requires the app to be served under a correctly set up and trusted TLS endpoint.
@ -692,15 +692,26 @@ If you want to test PWA features, you need to trust the CA of the certificate fo
For your convenience, you can download the crt file from `http://<Your FQDN>:8080/ca.crt`. \ For your convenience, you can download the crt file from `http://<Your FQDN>:8080/ca.crt`. \
Install that certificate to the trust store of your operating system. \ Install that certificate to the trust store of your operating system. \
- On Windows, make sure to install it to the `Trusted Root Certification Authorities` store. ##### Windows
- On macOS, double-click the installed CA certificate in `Keychain Access`, - Make sure to install it to the `Trusted Root Certification Authorities` store.
##### macOS
- Double-click the installed CA certificate in `Keychain Access`,
- expand `Trust`, and select `Always Trust` for SSL. - expand `Trust`, and select `Always Trust` for SSL.
##### Firefox
- Firefox uses its own trust store. To install the CA, - Firefox uses its own trust store. To install the CA,
- point Firefox at `http://<Your FQDN>:8080/ca.crt`. - point Firefox at `http://<Your FQDN>:8080/ca.crt`.
- When prompted, select `Trust this CA to identify websites` and click _OK_. - When prompted, select `Trust this CA to identify websites` and click _OK_.
##### Chrome
- When using Chrome, you need to restart Chrome so it reloads the trust store (`chrome://restart`). - When using Chrome, you need to restart Chrome so it reloads the trust store (`chrome://restart`).
- Additionally, after installing a new cert, you need to clear the Storage (DevTools → Application → Clear storage → Clear site data). - Additionally, after installing a new cert, you need to clear the Storage (DevTools → Application → Clear storage → Clear site data).
##### Google Chrome
- To skip the installation of the certificate, you can also open `chrome://flags/#unsafely-treat-insecure-origin-as-secure`
- The feature `Insecure origins treated as secure` must be enabled and the list must include your PairDrop test instance. E.g.: `http://127.0.0.1:3000,https://127.0.0.1:8443`
Please note that the certificates (CA and webserver cert) expire after a day. Please note that the certificates (CA and webserver cert) expire after a day.
Also, whenever you restart the NGINX Docker container new certificates are created. Also, whenever you restart the NGINX Docker container new certificates are created.