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 all 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
10 changes: 10 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,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
```
26 changes: 26 additions & 0 deletions website/docs/administration/reverse-proxy.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Deploy 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';

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