From ae9418035cac73b907434f60a8160a2538da08b8 Mon Sep 17 00:00:00 2001 From: jtbr Date: Fri, 28 Jun 2024 11:49:30 +0200 Subject: [PATCH] docs: clarify upgrade procedure and add doc of linux standalone executables (#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 Co-authored-by: Meng Zhang Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> --- website/docs/administration/context/index.mdx | 2 + website/docs/administration/upgrade.md | 8 ++- .../quick-start/installation/linux/assets.png | 3 ++ .../quick-start/installation/linux/index.mdx | 49 +++++++++++++++++++ 4 files changed, 60 insertions(+), 2 deletions(-) create mode 100644 website/docs/quick-start/installation/linux/assets.png create mode 100644 website/docs/quick-start/installation/linux/index.mdx diff --git a/website/docs/administration/context/index.mdx b/website/docs/administration/context/index.mdx index c0aa6679e969..4786e4036c5c 100644 --- a/website/docs/administration/context/index.mdx +++ b/website/docs/administration/context/index.mdx @@ -24,6 +24,8 @@ The repository context is used to connect Tabby with a source code repository fr Git + 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. diff --git a/website/docs/administration/upgrade.md b/website/docs/administration/upgrade.md index 9ac2d0d4ef6b..e237bda364b5 100644 --- a/website/docs/administration/upgrade.md +++ b/website/docs/administration/upgrade.md @@ -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. \ No newline at end of file +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. diff --git a/website/docs/quick-start/installation/linux/assets.png b/website/docs/quick-start/installation/linux/assets.png new file mode 100644 index 000000000000..b315e24e40e9 --- /dev/null +++ b/website/docs/quick-start/installation/linux/assets.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a536bf891a95cad1a62984567cf977952dcf9f5561bb8988c2c52dbc71f9b3c9 +size 86241 diff --git a/website/docs/quick-start/installation/linux/index.mdx b/website/docs/quick-start/installation/linux/index.mdx new file mode 100644 index 000000000000..84c89ca6941e --- /dev/null +++ b/website/docs/quick-start/installation/linux/index.mdx @@ -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. +
+ Linux release +
+ +## 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. +
+ Linux running success +
\ No newline at end of file