From 763de8461cd9458b0f523c3bc1c12dc74b95a003 Mon Sep 17 00:00:00 2001 From: oli-ver Date: Sun, 20 Oct 2024 13:34:38 +0530 Subject: [PATCH 1/6] docs(administration): add reverse proxy documentation * chore: add instructions how to run tabby behind nginx reverse proxy --- website/docs/administration/reverse-proxy.mdx | 29 +++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 website/docs/administration/reverse-proxy.mdx diff --git a/website/docs/administration/reverse-proxy.mdx b/website/docs/administration/reverse-proxy.mdx new file mode 100644 index 000000000000..b3def2e81bcc --- /dev/null +++ b/website/docs/administration/reverse-proxy.mdx @@ -0,0 +1,29 @@ +--- +sidebar_position: 3 +--- + +# Deploy Tabby behind a reverse proxy +This guide explains how to use Tabby behind a reverse proxy. + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + + Add the following to your Nginx configuration: + + ``` + location / { + proxy_pass http://localhost:8080; + proxy_set_header Host $host; + proxy_set_header X-Real-IP $remote_addr; + proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; + proxy_http_version 1.1; + proxy_set_header Upgrade $http_upgrade; + proxy_set_header Connection "upgrade"; + } + ``` + + + From 745f2f82c3c5d826669e9d025d50b907628a5d7d Mon Sep 17 00:00:00 2001 From: oli-ver Date: Sun, 20 Oct 2024 16:28:21 +0530 Subject: [PATCH 2/6] docs(contribution): add website instructions * docs: add contribution information for the website code --- CONTRIBUTING.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 998e272310aa..63c28f22dded 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,6 +4,8 @@ Thank you for your interest in contributing to Tabby! We appreciate all contribu ## Local Setup +### Tabby + To begin contributing to Tabby, first clone the repository locally: ``` @@ -46,6 +48,16 @@ Optionally, to use a GPU make sure you have the correct drivers and libraries in > **CUDA for Nvidia** - [Linux](https://docs.nvidia.com/cuda/cuda-installation-guide-linux/index.html), [Windows](https://docs.nvidia.com/cuda/cuda-installation-guide-microsoft-windows/index.html) > **ROCm for AMD** - [Linux](https://rocm.docs.amd.com/projects/install-on-linux/en/latest/tutorial/quick-start.html), [Windows](https://rocm.docs.amd.com/projects/install-on-linux/en/latest/) +### Website + +To begin contributing to Tabby's website, make sure you installed [nvm](https://github.com/nvm-sh/nvm?tab=readme-ov-file#install--update-script), node lts and yarn: + +``` +nvm install --lts +cd website +yarn install +yarn start +``` ## Building and Running Tabby can be run through `cargo` in much the same manner as docker: From c58cd2afb01572fe3ca3d4d09f63e69a6b823f09 Mon Sep 17 00:00:00 2001 From: Meng Zhang Date: Wed, 23 Oct 2024 07:49:44 -0700 Subject: [PATCH 3/6] Update CONTRIBUTING.md --- CONTRIBUTING.md | 1 - 1 file changed, 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 63c28f22dded..0c78a3932e84 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -53,7 +53,6 @@ Optionally, to use a GPU make sure you have the correct drivers and libraries in To begin contributing to Tabby's website, make sure you installed [nvm](https://github.com/nvm-sh/nvm?tab=readme-ov-file#install--update-script), node lts and yarn: ``` -nvm install --lts cd website yarn install yarn start From 3b6514c6e06ab53ed570938f502d03ba8a830610 Mon Sep 17 00:00:00 2001 From: Meng Zhang Date: Wed, 23 Oct 2024 07:50:02 -0700 Subject: [PATCH 4/6] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0c78a3932e84..bee416dc31b8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -50,7 +50,7 @@ Optionally, to use a GPU make sure you have the correct drivers and libraries in ### Website -To begin contributing to Tabby's website, make sure you installed [nvm](https://github.com/nvm-sh/nvm?tab=readme-ov-file#install--update-script), node lts and yarn: +To begin contributing to Tabby's website, make sure you installed node lts and yarn: ``` cd website From ff91395d25e4af7cb4cb5f5e04149f20ef9c962c Mon Sep 17 00:00:00 2001 From: Meng Zhang Date: Wed, 23 Oct 2024 07:55:00 -0700 Subject: [PATCH 5/6] improve writing --- website/docs/administration/reverse-proxy.mdx | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/website/docs/administration/reverse-proxy.mdx b/website/docs/administration/reverse-proxy.mdx index b3def2e81bcc..3bcd832e7052 100644 --- a/website/docs/administration/reverse-proxy.mdx +++ b/website/docs/administration/reverse-proxy.mdx @@ -1,9 +1,6 @@ ---- -sidebar_position: 3 ---- - # Deploy Tabby behind a reverse proxy -This guide explains how to use Tabby behind a reverse proxy. + +As an HTTP service, Tabby can be easily deployed behind a reverse proxy. The only thing you need to pay attention to is enabling the WebSocket connection, as it is used for the answer engine streaming. import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; From 98e2649058ee790c4fdc8f6c0ef83ac9273cf1f5 Mon Sep 17 00:00:00 2001 From: Meng Zhang Date: Wed, 23 Oct 2024 07:57:53 -0700 Subject: [PATCH 6/6] update --- CONTRIBUTING.md | 21 ++++++++++----------- 1 file changed, 10 insertions(+), 11 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bee416dc31b8..308498efb2c4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,8 +4,6 @@ Thank you for your interest in contributing to Tabby! We appreciate all contribu ## Local Setup -### Tabby - To begin contributing to Tabby, first clone the repository locally: ``` @@ -48,15 +46,6 @@ Optionally, to use a GPU make sure you have the correct drivers and libraries in > **CUDA for Nvidia** - [Linux](https://docs.nvidia.com/cuda/cuda-installation-guide-linux/index.html), [Windows](https://docs.nvidia.com/cuda/cuda-installation-guide-microsoft-windows/index.html) > **ROCm for AMD** - [Linux](https://rocm.docs.amd.com/projects/install-on-linux/en/latest/tutorial/quick-start.html), [Windows](https://rocm.docs.amd.com/projects/install-on-linux/en/latest/) -### Website - -To begin contributing to Tabby's website, make sure you installed node lts and yarn: - -``` -cd website -yarn install -yarn start -``` ## Building and Running Tabby can be run through `cargo` in much the same manner as docker: @@ -129,3 +118,13 @@ Once your PR is ready, please request review from one of the [Tabby team members # Changelog Tabby used [changie](changie.dev) to track unreleased features, it's preferred the changelog is added as part of implementation pr. To create an unreleased feature, use `change new` command. + +# Contributing to Docs + +To begin contributing to Tabby's docs website, make sure you installed node lts and yarn: + +``` +cd website +yarn install +yarn start +``` \ No newline at end of file