Skip to content

Latest commit

 

History

History
216 lines (160 loc) · 8.95 KB

README.md

File metadata and controls

216 lines (160 loc) · 8.95 KB
Raw

Goodtok

Contribute with Gitpod Sponsor this Discord GitHub Twitter Follow

Goodtok helps businesses enhance their customer service right from their website. The video application lets customers connect with your staff in real-time. You can integrate this simple and easy-to-use application into any website.

Warning

This project is just starting and is not ready for production use yet.

Table of Contents

Give a Star! ⭐

It would mean a lot to us if you could give this project a star. It helps us identify if we are doing a good job and attract potential contributors, users, and investors. Thanks 🙏

Installation

We aim to make this as easy to install as possible. For now, follow the following instructions to get started.

First, create a new directory called goodtok and change to that directory:

mkdir goodtok
cd goodtok

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

# General config
API_ENDPOINT=http://localhost:6789/v1
APP_URL=http://localhost:8080
LOGS_LEVEL=verbose

# Initial store owner credentials
#   The server will create a new owner if the email does not exist
#   The password will be updated if the email exists
[email protected]
OWNER_PASSWORD=changeme

# PeerJs Server config
SIGNALING_HOST=localhost
SIGNALING_PORT=9000
# Ucomment to use custom ICE servers
# ICE_SERVERS_CONFIG='[{"urls": "stun:stun.l.google.com:19302"}, {"urls": "turn:us-turn4.xirsys.com:80?transport=udp", "username": "xirsys", "credential": "xirsys"}]'

# SMTP config
SMTP_HOST=localhost
SMTP_PORT=1025
SMTP_SECURE=false
[email protected]
SMTP_AUTH_PASS=secret
SMTP_SENDER=Goodtok Info <[email protected]>

# Database and encryption config
# Create a new encryption key with cloack (https://cloack.47ng.com)
POSTGRES_USER=postgres
POSTGRES_PASSWORD=postgres
DATABASE_URL=postgresql://postgres:postgres@postgres:5432/goodtok
CLOAK_ENCRYPTION_KEY=k1.aesgcm256.MmPSvzCG9fk654bAbl30tsqq4h9d3N4F11hlue8bGAY=

# Uncomment to enable custom email templates
#  See mods/apiserver/src/notifications/templates for available templates
#  If not set, Goodtok will use the default templates
# EMAIL_TEMPLATES_DIR=/path/to/email/templates

Finally, run the following command to start the application:

curl -o ./compose.yaml https://raw.githubusercontent.com/fonoster/goodtok/main/compose.yaml
docker compose up -d

The previous command will start all the services, including the Front Office. You can then open the application at http://localhost:8080 and access the dashboard.

Development mode with Gitpod

Goodtok's one-click interactive deployment will familiarize you with the server in development mode.

Open in Gitpod

Usage

In the website where you want to integrate Goodtok, you will need to add the following script tag:

<!-- Goodtok video client -->
<script
  type="module"
  src="https://unpkg.com/@goodtok/widget?key=eyJndGlkIjoiZy00ZjkwZDEzYTQyIiwic2VydmVyIjoiaHR0cHM6Ly9hcGkuZ29vZHRvay5pby92MSJ9&token=OPTIONAL_CUSTOMER_TOKEN"
>
</script>
<!-- Goodtok video client end -->

The key is a base64 encoded value containing the account gtid and server of your Goodtok instance. You can generate this value by running the following command:

# The gtid corresponds to the workspace id in the Goodtok dashboard
echo -n '{"gtid":"g-7b7c46fb05","server":"http://localhost:6789/v1"}' | base64

The client will default to https://api.goodtok.io/v1 if no server is specified.

A customer token is a JSON Web Token with necessary claims to authenticate the user and connect to the signaling server. Here is an example of the claims for a customer token:

{
  "ref": "iypok",
  "customerId": "iypok",
  "workspaceId": "g-7b7c46fb05",
  "calendarUrl": "https://cal.com/placeholder",
  "signalingHost": "peerjs.goodtok.io",
  "signalingPort": 443,
  "iceServers": {...}
  "metadata": {
    "name": "Peter",
    "email": "[email protected]",
    "message": "Test message"
  },
  "iat": 1701740245,
  "exp": 1701826645
}

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. We recommend providing a customer token to the video widget to avoid the form.

To learn more about customer tokens, see the customer tokens section in the documentation.

Architecture

Goodtok uses a combination of open-source tools to provide a video application that can be integrated into any website. If the tool exists and is well maintained, we will use and support it. If the tool doesn't exist, we build and open-source it ourselves.

Goodtok is a hosted platform. You can sign up and start using Goodtok without installing anything. You can also self-host and develop locally.

  • Postgres is a popular open-source database with a proven architecture that has earned it a strong reputation for reliability, data integrity, and correctness.
  • tRPC is a library for building end-to-end type-safe APIs with TypeScript and Node.js. We connect all the services using tRPC.
  • SMTP is an Internet standard for email transmission. We use SMTP to send emails to customers and agents.
  • PeerJS simplifies WebRTC peer-to-peer data, video, and audio calls. We use PeerJS to establish a WebRTC connection between the customer and the agent.

Contact us

Meet our sales team for any commercial inquiries.

Book us with Cal.com

Bugs and Feature Requests

For bugs or feature requests, please create an issue here. For questions, take a look at the Discussions section.

Known Issues

When running Goodtok without a TLS certificate, you must add the following to your browser to allow the camera to work: chrome://flags/#unsafely-treat-insecure-origin-as-secure or an equivalent for your browser. The camera will not work on an insecure origin.

Contributing

For contributing, please see the following links:

Pedro
Pedro Sanders 		Obruche
Obruche Wilfred Oghenechohwo

Authors

License

This project is licensed under the MIT License - see the LICENSE file for details.