Skip to content

Commit

Permalink
chore: update docs to reflect migration to PeerJS
Browse files Browse the repository at this point in the history
  • Loading branch information
psanders committed Dec 20, 2023
1 parent 9e11937 commit 1a48b44
Show file tree
Hide file tree
Showing 8 changed files with 141 additions and 9,114 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ A customer token is a [JSON Web Token](https://jwt.io/) with necessay claims to
"ref": "iypok",
"customerId": "iypok",
"workspaceId": "g-7b7c46fb05",
"calendarUrl": "https://cal.com/psanders",
"calendarUrl": "https://cal.com/placeholder",
"signalingHost": "peerjs.goodtok.io",
"signalingPort": 443,
"metadata": {
Expand All @@ -128,7 +128,7 @@ A customer token is a [JSON Web Token](https://jwt.io/) with necessay claims to

When no customer token is provided, the video widget will show a form, requesting the user to enter their name, email and a message. The video widget will then request an anonymous token from the server. When possible we recommend you to provide a customer token to the video widget to avoid the form.

To learn more about customer tokens, see the [customer tokens](http://localhost:3000/docs/video-widget/customer-tokens) section in the documentation.
To learn more about customer tokens, see the [customer tokens](https://goodtok.io/docs/video-widget/customer-tokens) section in the documentation.

## Architecture

Expand Down
5 changes: 1 addition & 4 deletions docs/docs/contributing/development-environment-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,6 @@ git clone https://github.com/fonoster/goodtok
cd goodtok
npm install
npm run build
mkdir -p .keys
openssl genpkey -algorithm RSA -out ./.keys/private.key -pkeyopt rsa_keygen_bits:4096
openssl rsa -in ./.keys/private.key -pubout -out ./.keys/public.key
```

### Running the project
Expand Down Expand Up @@ -65,7 +62,7 @@ npm run db:migrate

Then, copy the `.env.example` file to `.env` and update the values accordingly.

You will need to update the `DOCKER_HOST_ADDRESS` and `SIP_SIGNALING_SERVER` variables with the IP address of your Docker host. Similarly, you will need to update the `CLOAK_ENCRYPTION_KEY` variable with a new key from [Cloak](https://cloak.47ng.com/).
You will need to update the `CLOAK_ENCRYPTION_KEY` variable with a new key from [Cloak](https://cloak.47ng.com/).

Finally, you can start the backend by running:

Expand Down
12 changes: 3 additions & 9 deletions docs/docs/self-hosting/deploy-with-docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,7 @@ mkdir goodtok
cd goodtok
```

Next, run the following command inside the directory to generate a set of security keys. These keys will be used to sign and verify the JWT tokens.

```bash
mkdir -p .keys
openssl genpkey -algorithm RSA -out ./.keys/private.key -pkeyopt rsa_keygen_bits:4096
openssl rsa -in ./.keys/private.key -pubout -out ./.keys/public.key
```

Then, create a `.env` file with the following content:
Next, create a `.env` file with the following content:

```bash
# General config
Expand Down Expand Up @@ -59,6 +51,8 @@ Few important things to note:

- Please be sure to update all secrets with your own values
- The `APP_URL` must be the URL where the application will be accessible. For example, if you are running the application locally, you can use `http://localhost:8080`. If you are running the application on a server, you can use, for example, `https://goodtok.example.com`
- The `SIGNALING_HOST` must be the URL where the signaling server will be accessible. For example, if you are running the application locally, you can use `localhost`. If you are running the application on a server, you can use, for example, `goodtok.example.com`
- The `SIGNALLING_PORT` must be the port where the signaling server will be accessible. For example, if you are running the application locally, you can use `9000`. If you are running the application on a server, you can use, for example, `443`
- You must point your SMTP variables to a valid SMTP server
- Goodtok will use the `OWNER_EMAIL` and `OWNER_PASSWORD` variables to create the first user. The server will create a new owner if the email does not exist. Goodtok will update the password if the email exists. You can use any email address and password for this purpose.

Expand Down
Loading

0 comments on commit 1a48b44

Please sign in to comment.