Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(doc): website contribution and nginx reverse proxy configuration #3291

Merged
merged 6 commits into from
Oct 23, 2024
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

```
Expand Down Expand Up @@ -46,6 +48,15 @@ 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:
wsxiaoys marked this conversation as resolved.
Show resolved Hide resolved

```
cd website
yarn install
yarn start
```
## Building and Running

Tabby can be run through `cargo` in much the same manner as docker:
Expand Down
29 changes: 29 additions & 0 deletions website/docs/administration/reverse-proxy.mdx
Original file line number Diff line number Diff line change
@@ -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';

<Tabs>
<TabItem value="nginx" label="Nginx" default>

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";
}
```

</TabItem>
</Tabs>