From 04ee63c23ce486b2f632907bee59b741f69fbd4b Mon Sep 17 00:00:00 2001 From: psanders Date: Tue, 5 Dec 2023 02:00:20 +0000 Subject: [PATCH] deploy: 3d04fe6e953af9ba1432178b5fc0d3e55a824021 --- 404.html | 4 ++-- assets/js/{5f5eb927.008c41c9.js => 5f5eb927.c0f98ee4.js} | 2 +- .../{runtime~main.cf6cc5cf.js => runtime~main.8d92311c.js} | 2 +- docs/contributing/development-environment-setup/index.html | 4 ++-- docs/contributing/guide/index.html | 4 ++-- docs/self-hosting/deploy-with-docker/index.html | 4 ++-- docs/self-hosting/introduction/index.html | 4 ++-- docs/video-widget/customer-tokens/index.html | 4 ++-- docs/video-widget/installation/index.html | 6 +++--- docs/video-widget/introduction/index.html | 4 ++-- docs/welcome/index.html | 4 ++-- 11 files changed, 21 insertions(+), 21 deletions(-) rename assets/js/{5f5eb927.008c41c9.js => 5f5eb927.c0f98ee4.js} (94%) rename assets/js/{runtime~main.cf6cc5cf.js => runtime~main.8d92311c.js} (91%) diff --git a/404.html b/404.html index 87e6e99..806dc88 100644 --- a/404.html +++ b/404.html @@ -4,13 +4,13 @@ Page Not Found | Goodtok Docs - +
Skip to main content

Page Not Found

We could not find what you were looking for.

Please contact the owner of the site that linked you to the original URL and let them know their link is broken.

- + \ No newline at end of file diff --git a/assets/js/5f5eb927.008c41c9.js b/assets/js/5f5eb927.c0f98ee4.js similarity index 94% rename from assets/js/5f5eb927.008c41c9.js rename to assets/js/5f5eb927.c0f98ee4.js index 4d85531..0942e52 100644 --- a/assets/js/5f5eb927.008c41c9.js +++ b/assets/js/5f5eb927.c0f98ee4.js @@ -1 +1 @@ -"use strict";(self.webpackChunkroutr_docs=self.webpackChunkroutr_docs||[]).push([[6],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>f});var o=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);t&&(o=o.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,o)}return n}function a(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(o=0;o=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var s=o.createContext({}),c=function(e){var t=o.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):a(a({},t),e)),n},d=function(e){var t=c(e.components);return o.createElement(s.Provider,{value:t},e.children)},p="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return o.createElement(o.Fragment,{},t)}},m=o.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,s=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),p=c(n),m=r,f=p["".concat(s,".").concat(m)]||p[m]||u[m]||i;return n?o.createElement(f,a(a({ref:t},d),{},{components:n})):o.createElement(f,a({ref:t},d))}));function f(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,a=new Array(i);a[0]=m;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l[p]="string"==typeof e?e:r,a[1]=l;for(var c=2;c{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>a,default:()=>u,frontMatter:()=>i,metadata:()=>l,toc:()=>c});var o=n(7462),r=(n(7294),n(3905));const i={},a="Installation",l={unversionedId:"video-widget/installation",id:"video-widget/installation",title:"Installation",description:"In the website where you want to integrate Goodtok, you will need to add the following script tag:",source:"@site/docs/video-widget/installation.md",sourceDirName:"video-widget",slug:"/video-widget/installation",permalink:"/docs/video-widget/installation",draft:!1,editUrl:"https://github.com/fonoster/goodtok/edit/main/docs/docs/video-widget/installation.md",tags:[],version:"current",frontMatter:{},sidebar:"sidebar",previous:{title:"Introduction",permalink:"/docs/video-widget/introduction"},next:{title:"Customer Tokens",permalink:"/docs/video-widget/customer-tokens"}},s={},c=[],d={toc:c},p="wrapper";function u(e){let{components:t,...n}=e;return(0,r.kt)(p,(0,o.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h1",{id:"installation"},"Installation"),(0,r.kt)("p",null,"In the website where you want to integrate Goodtok, you will need to add the following script tag:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-html"},'\x3c!-- Goodtok video client --\x3e\n\n<\/script>\n\x3c!-- Goodtok video client end --\x3e\n')),(0,r.kt)("p",null,"Were the key is a ",(0,r.kt)("inlineCode",{parentName:"p"},"base64")," encoded value containing the Workspace GTID and server of your Goodtok instance. You can generate this value by running the following command:"),(0,r.kt)("p",null,"Use the following command to generate the key:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-bash"},'echo -n \'{"gtid":"g-7b7c46fb05","server":"http://localhost:6789/v1"}\' | base64\n')),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"gtid")," property corresponds to the Workspace id in the Goodtok dashboard."),(0,r.kt)("p",null,"If no server is specified, the client will default to ",(0,r.kt)("inlineCode",{parentName:"p"},"https://api.goodtok.io/v1.")),(0,r.kt)("p",null,"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."),(0,r.kt)("p",null,"To learn more about Customer tokens, see the ",(0,r.kt)("a",{parentName:"p",href:"#customer-tokens"},"Customer tokens")," section."))}u.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkroutr_docs=self.webpackChunkroutr_docs||[]).push([[6],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>f});var o=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);t&&(o=o.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,o)}return n}function a(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(o=0;o=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var s=o.createContext({}),c=function(e){var t=o.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):a(a({},t),e)),n},d=function(e){var t=c(e.components);return o.createElement(s.Provider,{value:t},e.children)},p="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return o.createElement(o.Fragment,{},t)}},m=o.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,s=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),p=c(n),m=r,f=p["".concat(s,".").concat(m)]||p[m]||u[m]||i;return n?o.createElement(f,a(a({ref:t},d),{},{components:n})):o.createElement(f,a({ref:t},d))}));function f(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,a=new Array(i);a[0]=m;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l[p]="string"==typeof e?e:r,a[1]=l;for(var c=2;c{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>a,default:()=>u,frontMatter:()=>i,metadata:()=>l,toc:()=>c});var o=n(7462),r=(n(7294),n(3905));const i={},a="Installation",l={unversionedId:"video-widget/installation",id:"video-widget/installation",title:"Installation",description:"In the website where you want to integrate Goodtok, you will need to add the following script tag:",source:"@site/docs/video-widget/installation.md",sourceDirName:"video-widget",slug:"/video-widget/installation",permalink:"/docs/video-widget/installation",draft:!1,editUrl:"https://github.com/fonoster/goodtok/edit/main/docs/docs/video-widget/installation.md",tags:[],version:"current",frontMatter:{},sidebar:"sidebar",previous:{title:"Introduction",permalink:"/docs/video-widget/introduction"},next:{title:"Customer Tokens",permalink:"/docs/video-widget/customer-tokens"}},s={},c=[],d={toc:c},p="wrapper";function u(e){let{components:t,...n}=e;return(0,r.kt)(p,(0,o.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h1",{id:"installation"},"Installation"),(0,r.kt)("p",null,"In the website where you want to integrate Goodtok, you will need to add the following script tag:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-html"},'\x3c!-- Goodtok video client --\x3e\n\n<\/script>\n\x3c!-- Goodtok video client end --\x3e\n')),(0,r.kt)("p",null,"Were the key is a ",(0,r.kt)("inlineCode",{parentName:"p"},"base64")," encoded value containing the Workspace GTID and server of your Goodtok instance. You can generate this value by running the following command:"),(0,r.kt)("p",null,"Use the following command to generate the key:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-bash"},'echo -n \'{"gtid":"g-7b7c46fb05","server":"http://localhost:6789/v1"}\' | base64\n')),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"gtid")," property corresponds to the Workspace id in the Goodtok dashboard."),(0,r.kt)("p",null,"If no server is specified, the client will default to ",(0,r.kt)("inlineCode",{parentName:"p"},"https://api.goodtok.io/v1.")),(0,r.kt)("p",null,"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."),(0,r.kt)("p",null,"To learn more about customer tokens, see the ",(0,r.kt)("a",{parentName:"p",href:"#customer-tokens"},"customer tokens")," section."))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.cf6cc5cf.js b/assets/js/runtime~main.8d92311c.js similarity index 91% rename from assets/js/runtime~main.cf6cc5cf.js rename to assets/js/runtime~main.8d92311c.js index 1cdc59a..bd9c0c2 100644 --- a/assets/js/runtime~main.cf6cc5cf.js +++ b/assets/js/runtime~main.8d92311c.js @@ -1 +1 @@ -(()=>{"use strict";var e,t,r,o,a,n={},f={};function d(e){var t=f[e];if(void 0!==t)return t.exports;var r=f[e]={id:e,loaded:!1,exports:{}};return n[e].call(r.exports,r,r.exports,d),r.loaded=!0,r.exports}d.m=n,d.c=f,e=[],d.O=(t,r,o,a)=>{if(!r){var n=1/0;for(u=0;u=a)&&Object.keys(d.O).every((e=>d.O[e](r[i])))?r.splice(i--,1):(f=!1,a0&&e[u-1][2]>a;u--)e[u]=e[u-1];e[u]=[r,o,a]},d.n=e=>{var t=e&&e.__esModule?()=>e.default:()=>e;return d.d(t,{a:t}),t},r=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,d.t=function(e,o){if(1&o&&(e=this(e)),8&o)return e;if("object"==typeof e&&e){if(4&o&&e.__esModule)return e;if(16&o&&"function"==typeof e.then)return e}var a=Object.create(null);d.r(a);var n={};t=t||[null,r({}),r([]),r(r)];for(var f=2&o&&e;"object"==typeof f&&!~t.indexOf(f);f=r(f))Object.getOwnPropertyNames(f).forEach((t=>n[t]=()=>e[t]));return n.default=()=>e,d.d(a,n),a},d.d=(e,t)=>{for(var r in t)d.o(t,r)&&!d.o(e,r)&&Object.defineProperty(e,r,{enumerable:!0,get:t[r]})},d.f={},d.e=e=>Promise.all(Object.keys(d.f).reduce(((t,r)=>(d.f[r](e,t),t)),[])),d.u=e=>"assets/js/"+({6:"5f5eb927",53:"935f2afb",73:"3def9de4",139:"abb1db76",195:"c4f5d8e4",294:"3458ea4a",305:"ebfee794",336:"d3d813ef",514:"1be78505",699:"4c3722f7",772:"d8dcc583",918:"17896441",931:"a1873b50",998:"96190ec7"}[e]||e)+"."+{6:"008c41c9",53:"4396bb05",73:"c4993b48",139:"0cda054c",195:"082b3a25",294:"10edf4f4",305:"a7d1bb9b",336:"f40e2199",514:"ca98ecb2",699:"690cc65b",772:"db99a4d0",918:"136c38cb",931:"168ffa60",972:"4464d779",998:"5cab6d98"}[e]+".js",d.miniCssF=e=>{},d.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),d.o=(e,t)=>Object.prototype.hasOwnProperty.call(e,t),o={},a="routr-docs:",d.l=(e,t,r,n)=>{if(o[e])o[e].push(t);else{var f,i;if(void 0!==r)for(var c=document.getElementsByTagName("script"),u=0;u{f.onerror=f.onload=null,clearTimeout(s);var a=o[e];if(delete o[e],f.parentNode&&f.parentNode.removeChild(f),a&&a.forEach((e=>e(r))),t)return t(r)},s=setTimeout(b.bind(null,void 0,{type:"timeout",target:f}),12e4);f.onerror=b.bind(null,f.onerror),f.onload=b.bind(null,f.onload),i&&document.head.appendChild(f)}},d.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},d.p="/",d.gca=function(e){return e={17896441:"918","5f5eb927":"6","935f2afb":"53","3def9de4":"73",abb1db76:"139",c4f5d8e4:"195","3458ea4a":"294",ebfee794:"305",d3d813ef:"336","1be78505":"514","4c3722f7":"699",d8dcc583:"772",a1873b50:"931","96190ec7":"998"}[e]||e,d.p+d.u(e)},(()=>{var e={303:0,532:0};d.f.j=(t,r)=>{var o=d.o(e,t)?e[t]:void 0;if(0!==o)if(o)r.push(o[2]);else if(/^(303|532)$/.test(t))e[t]=0;else{var a=new Promise(((r,a)=>o=e[t]=[r,a]));r.push(o[2]=a);var n=d.p+d.u(t),f=new Error;d.l(n,(r=>{if(d.o(e,t)&&(0!==(o=e[t])&&(e[t]=void 0),o)){var a=r&&("load"===r.type?"missing":r.type),n=r&&r.target&&r.target.src;f.message="Loading chunk "+t+" failed.\n("+a+": "+n+")",f.name="ChunkLoadError",f.type=a,f.request=n,o[1](f)}}),"chunk-"+t,t)}},d.O.j=t=>0===e[t];var t=(t,r)=>{var o,a,n=r[0],f=r[1],i=r[2],c=0;if(n.some((t=>0!==e[t]))){for(o in f)d.o(f,o)&&(d.m[o]=f[o]);if(i)var u=i(d)}for(t&&t(r);c{"use strict";var e,t,r,o,a,n={},f={};function d(e){var t=f[e];if(void 0!==t)return t.exports;var r=f[e]={id:e,loaded:!1,exports:{}};return n[e].call(r.exports,r,r.exports,d),r.loaded=!0,r.exports}d.m=n,d.c=f,e=[],d.O=(t,r,o,a)=>{if(!r){var n=1/0;for(u=0;u=a)&&Object.keys(d.O).every((e=>d.O[e](r[i])))?r.splice(i--,1):(f=!1,a0&&e[u-1][2]>a;u--)e[u]=e[u-1];e[u]=[r,o,a]},d.n=e=>{var t=e&&e.__esModule?()=>e.default:()=>e;return d.d(t,{a:t}),t},r=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,d.t=function(e,o){if(1&o&&(e=this(e)),8&o)return e;if("object"==typeof e&&e){if(4&o&&e.__esModule)return e;if(16&o&&"function"==typeof e.then)return e}var a=Object.create(null);d.r(a);var n={};t=t||[null,r({}),r([]),r(r)];for(var f=2&o&&e;"object"==typeof f&&!~t.indexOf(f);f=r(f))Object.getOwnPropertyNames(f).forEach((t=>n[t]=()=>e[t]));return n.default=()=>e,d.d(a,n),a},d.d=(e,t)=>{for(var r in t)d.o(t,r)&&!d.o(e,r)&&Object.defineProperty(e,r,{enumerable:!0,get:t[r]})},d.f={},d.e=e=>Promise.all(Object.keys(d.f).reduce(((t,r)=>(d.f[r](e,t),t)),[])),d.u=e=>"assets/js/"+({6:"5f5eb927",53:"935f2afb",73:"3def9de4",139:"abb1db76",195:"c4f5d8e4",294:"3458ea4a",305:"ebfee794",336:"d3d813ef",514:"1be78505",699:"4c3722f7",772:"d8dcc583",918:"17896441",931:"a1873b50",998:"96190ec7"}[e]||e)+"."+{6:"c0f98ee4",53:"4396bb05",73:"c4993b48",139:"0cda054c",195:"082b3a25",294:"10edf4f4",305:"a7d1bb9b",336:"f40e2199",514:"ca98ecb2",699:"690cc65b",772:"db99a4d0",918:"136c38cb",931:"168ffa60",972:"4464d779",998:"5cab6d98"}[e]+".js",d.miniCssF=e=>{},d.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),d.o=(e,t)=>Object.prototype.hasOwnProperty.call(e,t),o={},a="routr-docs:",d.l=(e,t,r,n)=>{if(o[e])o[e].push(t);else{var f,i;if(void 0!==r)for(var c=document.getElementsByTagName("script"),u=0;u{f.onerror=f.onload=null,clearTimeout(b);var a=o[e];if(delete o[e],f.parentNode&&f.parentNode.removeChild(f),a&&a.forEach((e=>e(r))),t)return t(r)},b=setTimeout(s.bind(null,void 0,{type:"timeout",target:f}),12e4);f.onerror=s.bind(null,f.onerror),f.onload=s.bind(null,f.onload),i&&document.head.appendChild(f)}},d.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},d.p="/",d.gca=function(e){return e={17896441:"918","5f5eb927":"6","935f2afb":"53","3def9de4":"73",abb1db76:"139",c4f5d8e4:"195","3458ea4a":"294",ebfee794:"305",d3d813ef:"336","1be78505":"514","4c3722f7":"699",d8dcc583:"772",a1873b50:"931","96190ec7":"998"}[e]||e,d.p+d.u(e)},(()=>{var e={303:0,532:0};d.f.j=(t,r)=>{var o=d.o(e,t)?e[t]:void 0;if(0!==o)if(o)r.push(o[2]);else if(/^(303|532)$/.test(t))e[t]=0;else{var a=new Promise(((r,a)=>o=e[t]=[r,a]));r.push(o[2]=a);var n=d.p+d.u(t),f=new Error;d.l(n,(r=>{if(d.o(e,t)&&(0!==(o=e[t])&&(e[t]=void 0),o)){var a=r&&("load"===r.type?"missing":r.type),n=r&&r.target&&r.target.src;f.message="Loading chunk "+t+" failed.\n("+a+": "+n+")",f.name="ChunkLoadError",f.type=a,f.request=n,o[1](f)}}),"chunk-"+t,t)}},d.O.j=t=>0===e[t];var t=(t,r)=>{var o,a,n=r[0],f=r[1],i=r[2],c=0;if(n.some((t=>0!==e[t]))){for(o in f)d.o(f,o)&&(d.m[o]=f[o]);if(i)var u=i(d)}for(t&&t(r);c Development environment setup | Goodtok Docs - +

Development environment setup

We welcome contributions from the community. This guide will help you get started with your development environment.

Using Gitpod​

The fastest way to get started is using Gitpod. With a single click, you can start a fully functional development environment with all the tools you need already pre-installed.

Open in Gitpod

This will start a workspace with all the dependencies installed and instances of the API Server, Front Office, and Widget running. The workspace should automatically open the Front Office, Widget, and the Mailhog UI. If not, you can open them manually by going to the Ports tab and clicking on the Open Browser button.

⚠️ We have an outstanding issue to make calls using this setup

Local setup​

Prerequisites​

Once you have the prerequisites installed, you can clone the repository and install the dependencies:

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​

To run the project, you need to start the dependencies services, then the backend, and finally the frontend and Widget.

Starting the dependencies​

docker-compose -f compose.yaml -f compose.dev.yaml up mailhog nats routr postgres adminer -d

The previous command will start the services in the background. If you want to see the logs, you can remove the -d flag.

It is important to highlight that any emails sent by the application will be intercepted by Mailhog. You can access the Mailhog UI at http://localhost:8025.

To stop the services, run:

docker-compose -f compose.yaml -f compose.dev.yaml down

Starting the API Server​

Before starting the backend you need to initialize the database and create a .env file.

First, initialize the database by running the following command:

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.

Finally, you can start the backend by running:

npm run start:apiserver

Starting the Front Office​

To start the Front Office, run:

npm run start:frontoffice

Starting the Widget​

To start the Widget, run:

npm run start:widget

By default we create a Goodtok Workspace and the Widget will connect to it. When you open the Widget, you might see it is offline. That means that the Workspace is disabled or you are outside the hours of operations. You can change that by going to the Workspace settings and enabling it.

- + \ No newline at end of file diff --git a/docs/contributing/guide/index.html b/docs/contributing/guide/index.html index 4aaaaea..fe891cc 100644 --- a/docs/contributing/guide/index.html +++ b/docs/contributing/guide/index.html @@ -4,14 +4,14 @@ Contributing guide | Goodtok Docs - +

Contributing guide

Welcome! We are glad that you want to contribute to our project! 💖

As you get started, you are in the best position to give us feedback on areas of our project that we need help with including:

  • Problems found during setting up a new developer environment
  • Gaps in our Quickstart Guide or documentation
  • Bugs in our automation scripts

If anything doesn't make sense, or doesn't work when you run it, please open a bug report and let us know!

Ways to contribute​

We welcome many different types of contributions including:

  • New features
  • Builds, CI/CD
  • Bug fixes
  • Documentation
  • Issue Triage
  • Answering questions on Discord/GitHub Discussions
  • Web design
  • UI/UX
  • Communications / Social Media / Blog Posts
  • Release management

Not everything happens through a GitHub pull request. Please come to our meetings or contact us and let's discuss how we can work together.

Come to meetings​

Absolutely everyone is welcome to come to any of our meetings. You never need an invite to join us. In fact, we want you to join us, even if you don’t have anything you feel like you want to contribute. Just being there is enough!

You can find out more about our meetings here. You don’t have to turn on your video. The first time you come, introducing yourself is more than enough.

Over time, we hope that you feel comfortable voicing your opinions, giving feedback on others' ideas, and even sharing your own ideas, and experiences.

Find an issue​

We have good first issues for new contributors and help wanted issues suitable for any contributor. good first issue has extra information to help you make your first contribution. help wanted are issues suitable for someone who isn't a core maintainer and is good to move onto after your first pull request.

Sometimes there won’t be any issues with these labels. That’s ok! There is likely still something for you to work on. If you want to contribute but you don’t know where to start or can't find a suitable issue, you can reach out to us via Discord or GitHub Discussions and we will help you find something.

Once you see an issue that you'd like to work on, please post a comment saying that you want to work on it. Something like "I want to work on this" is fine.

Ask for help​

The best way to reach us with a question when contributing is to ask on:

Pull request lifecycle​

Before you start, ensure no one else is working on the same issue. If a related pull request exists, consider offering your assistance there. If you don't receive a response within a reasonable timeframe, you can proceed with your own pull request.

After you've submitted your pull request, it enters the review stage. During this time, the project maintainers or contributors will examine your changes. They might request modifications, such as:

  • Enhancements in your code
  • Additional tests or updates to the documentation
  • Changes in your implementation approach
  • Dividing your pull request into smaller, more manageable parts

Depending on the project’s roadmap and priorities, you might also be asked to:

  • Delay the integration of your pull request to align with future releases
  • Close your current pull request and, if needed, open a new one with revised changes

Development environment setup​

See our Development environment setup guide to get started locally or using Gitpod.

Sign your commits​

DCO​

Licensing is important to open source projects. It provides some assurances that the software will continue to be available based under the terms that the author(s) desired. We require that contributors sign off on commits submitted to our project's repositories. The Developer Certificate of Origin (DCO) is a way to certify that you wrote and have the right to contribute the code you are submitting to the project.

You sign-off by adding the following to your commit messages. Your sign-off must match the git user and email associated with the commit.

This is my commit message

Signed-off-by: Your Name <your.name@example.com>

Git has a -s command line option to do this automatically:

git commit -s -m 'This is my commit message'

If you forgot to do this and have not yet pushed your changes to the remote repository, you can amend your commit with the sign-off by running 

git commit --amend -s

Pull request checklist​

When you submit your pull request, or you push new commits to it, our automated systems will run some checks on your new code. We require that your pull request passes these checks, but we also have more criteria than just that before we can accept and merge it. We recommend that you check the following things locally before you submit your code:

  • Your code builds and passes tests locally
  • Your code passes our automated checks
  • You have signed your commits
  • You have added tests for your code (if applicable)
  • You have updated the documentation (if applicable)
- + \ No newline at end of file diff --git a/docs/self-hosting/deploy-with-docker/index.html b/docs/self-hosting/deploy-with-docker/index.html index b908b9f..997fa9a 100644 --- a/docs/self-hosting/deploy-with-docker/index.html +++ b/docs/self-hosting/deploy-with-docker/index.html @@ -4,13 +4,13 @@ Deploy with Docker | Goodtok Docs - +

Deploy with Docker

Docker compose is the easiest way to deploy a self-hosted instance of Goodtok. This guide will walk you through the process of deploying the Goodtok services using Docker and Docker Compose.

Prerequisites​

Installation​

First, create a new directory in your preferred location and change to that directory. For this guide, we will use the directory goodtok in the home directory.

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.

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:

# General config
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
#   Goodtok will the password if the email exists
OWNER_EMAIL=admin@goodtok.local
OWNER_PASSWORD=changeme

# SMTP config
SMTP_HOST=localhost
SMTP_PORT=1025
SMTP_SECURE=false
SMTP_AUTH_USER=postmaster@goodtok.local
SMTP_AUTH_PASS=secret
SMTP_SENDER=Goodtok Info <info@goodtok.local>

# SIP signaling config
DOCKER_HOST_ADDRESS=/* The public IP address of your Docker host */
SIP_SIGNALING_SERVER=ws:/* The public IP address of your Docker host */:5062
SIP_DOMAIN=sip.goodtok.local

# Database and encryption config
POSTGRES_USER=postgres
POSTGRES_PASSWORD=postgres
DATABASE_URL=postgresql://postgres:postgres@postgres:5432/goodtok
CLOAK_ENCRYPTION_KEY=/* Generate a new key with cloack cli or https://cloak.47ng.com/ */

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 DOCKER_HOST_ADDRESS must be the public IP address of your Docker host. If running locally, you can use your local IP address. If you are running the application on a server, you must use the public IP address of your server
  • The SIP_SIGNALING_SERVER must be the public IP address of your Docker host. If running locally, you can use your local IP address. If you are running the application on a server, you must use the public IP address of your server
  • The value of the SIP_DOMAIN can be any domain name since it is a synthetic domain. However, we recommend using a domain name that you own. For example, if you own the domain example.com, you can use sip.example.com as the value of the SIP_DOMAIN variable
  • 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.

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.

Securing the application​

Comming soon...

- + \ No newline at end of file diff --git a/docs/self-hosting/introduction/index.html b/docs/self-hosting/introduction/index.html index 0ba934b..670d0cd 100644 --- a/docs/self-hosting/introduction/index.html +++ b/docs/self-hosting/introduction/index.html @@ -4,13 +4,13 @@ Introduction | Goodtok Docs - +

Introduction

Self-hosting Goodtok involves running the Goodtok server on your server. Self-hosting is useful if you want to run Goodtok on a private network or if you want to customize Goodtok's behavior. While this offers more flexibility, it also requires more technical knowledge, and some features may not be available.

- + \ No newline at end of file diff --git a/docs/video-widget/customer-tokens/index.html b/docs/video-widget/customer-tokens/index.html index 4dc2955..8e3ba8e 100644 --- a/docs/video-widget/customer-tokens/index.html +++ b/docs/video-widget/customer-tokens/index.html @@ -4,13 +4,13 @@ Customer Tokens | Goodtok Docs - +

Customer Tokens

Comming soon...

- + \ No newline at end of file diff --git a/docs/video-widget/installation/index.html b/docs/video-widget/installation/index.html index 4f2d5e2..7a4cf90 100644 --- a/docs/video-widget/installation/index.html +++ b/docs/video-widget/installation/index.html @@ -4,13 +4,13 @@ Installation | Goodtok Docs - +
-

Installation

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 -->

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

Use the following command to generate the key:

echo -n '{"gtid":"g-7b7c46fb05","server":"http://localhost:6789/v1"}' | base64

The gtid property corresponds to the Workspace id in the Goodtok dashboard.

If no server is specified, the client will default to https://api.goodtok.io/v1.

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 section.

- +

Installation

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 -->

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

Use the following command to generate the key:

echo -n '{"gtid":"g-7b7c46fb05","server":"http://localhost:6789/v1"}' | base64

The gtid property corresponds to the Workspace id in the Goodtok dashboard.

If no server is specified, the client will default to https://api.goodtok.io/v1.

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 section.

+ \ No newline at end of file diff --git a/docs/video-widget/introduction/index.html b/docs/video-widget/introduction/index.html index 1f0b9d2..a20c33a 100644 --- a/docs/video-widget/introduction/index.html +++ b/docs/video-widget/introduction/index.html @@ -4,13 +4,13 @@ Introduction | Goodtok Docs - +

Introduction

The Goodtok Video Widget is a JavaScript snippet you can add to your website to enable video calls with your customers. It allows embedding or adding quick access so your clients or users can communicate via video call your business without leaving the website.

- + \ No newline at end of file diff --git a/docs/welcome/index.html b/docs/welcome/index.html index 65c7efd..25c15f5 100644 --- a/docs/welcome/index.html +++ b/docs/welcome/index.html @@ -4,13 +4,13 @@ Welcome | Goodtok Docs - +

Welcome

Community banner

This is the beginning of the documentation for Goodtok: A better shopping experience for your customers.

- + \ No newline at end of file