Skip to content

Commit

Permalink
docs: clarify upgrade procedure and add doc of linux standalone execu…
Browse files Browse the repository at this point in the history
…tables (#2531)

* Update upgrade.md

clarify upgrade procedure in different cases

* add documentation of linux standalone versions

* note how to access local git repos from within docker

* correct executable name

* Update website/docs/quick-start/installation/linux/index.mdx

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

---------

Co-authored-by: jtbr <[email protected]>
Co-authored-by: Meng Zhang <[email protected]>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
  • Loading branch information
4 people authored Jun 28, 2024
1 parent ede31b5 commit ae94180
Show file tree
Hide file tree
Showing 4 changed files with 60 additions and 2 deletions.
2 changes: 2 additions & 0 deletions website/docs/administration/context/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ The repository context is used to connect Tabby with a source code repository fr

<img src={GitUrl} alt="Git" width="700" />

Local repositories are supported via the file:// protocol, but if running from a Docker container, you need to make it accessible with the [`--volume` flag](https://docs.docker.com/reference/cli/docker/container/run/#volume) and use the internal Docker path.

- For GitHub / GitLab, a personal access token is required to access private repositories.
* Check the instructions in the corresponding tab to create a token.

Expand Down
8 changes: 6 additions & 2 deletions website/docs/administration/upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@ Tabby is a fast-evolving project, and we are constantly adding new features and
The standard procedure for upgrading Tabby involves the following steps:

1. Back up the Tabby database.
2. Restart Tabby.
2. Perform the upgrade
1. If using docker, pull the latest image: `docker pull tabbyml/tabby`
2. If using a standalone release, download it from the [releases page](https://github.com/TabbyML/tabby/releases) to replace the executable.
3. Otherwise, just:
5. Restart Tabby.

That's it! You've successfully upgraded Tabby. If you encounter any issues, please consider joining our [slack community](https://links.tabbyml.com/join-slack) for help.
That's it! You've successfully upgraded Tabby. If you encounter any issues, please consider joining our [slack community](https://links.tabbyml.com/join-slack) for help.
3 changes: 3 additions & 0 deletions website/docs/quick-start/installation/linux/assets.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
49 changes: 49 additions & 0 deletions website/docs/quick-start/installation/linux/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
sidebar_position: 3
---

import releaseImage from './assets.png';
import successImage from '../windows/success.png';

# Linux
Running Tabby on Linux using Tabby's standalone executable distribution.

## Find the Linux release
* Go to the Tabby release page: https://github.com/TabbyML/tabby/releases
* Click on the **Assets** dropdown for a specific release to find the manylinux zip files.
<div align="left">
<img src={releaseImage} alt="Linux release" style={{ width: 626 }} />
</div>

## Download the release
* If you are using a CPU-only system, download the **tabby_x86_64-manylinux2014.zip**.
* If you are using a GPU-enabled system, download the **tabby_x86_64-manylinux2014-cuda117.zip**, In this example, we assume you are using CUDA 11.7.
* If you want to use a non-nvidia GPU, download the **tabby_x86_64-manylinux2014-vulkan.zip**. See https://tabby.tabbyml.com/blog/2024/05/01/vulkan-support/ for more info.

**Tips:**
* For the CUDA versions, you will need the nvidia-cuda-toolkit installed for your distribution.
* In ubuntu, this would be `sudo apt install nvidia-cuda-toolkit`.
* The CUDA Toolkit is available directly from Nvidia: https://developer.nvidia.com/cuda-toolkit
* Ensure that you have CUDA version 11 or higher installed.
* Check your local CUDA version by running the following command in a terminal: `nvcc --version`
* For the Vulkan version you'll need the vulkan library. In ubuntu, this would be `sudo apt install libvulkan1`.

## Find the Linux executable file
* Unzip the file you downloaded. The `tabby` executable will be in a subdirectory of dist.
* Change to this subdirectory or relocate `tabby` to a folder of your choice.
* Make it executable: `chmod +x tabby`

Run the following command:
```
# For CPU-only environments
./tabby serve --model StarCoder-1B --chat-model Qwen2-1.5B-Instruct
# For GPU-enabled environments (where DEVICE is cuda or vulkan)
./tabby serve --model StarCoder-1B --chat-model Qwen2-1.5B-Instruct --device $DEVICE
```
You can choose different models, as shown in [the model registry](https://tabby.tabbyml.com/docs/models/)

You should see a success message similar to the one in the screenshot below. After that, you can visit http://localhost:8080 to access your Tabby instance.
<div align="left">
<img src={successImage} alt="Linux running success" style={{ width: 800 }} />
</div>

0 comments on commit ae94180

Please sign in to comment.