From 1b7e657afdbd2bc17241a46b309cc0c0218ae7a4 Mon Sep 17 00:00:00 2001 From: Meng Zhang Date: Mon, 4 Sep 2023 14:23:13 +0800 Subject: [PATCH] docs: adjust self-hosting section --- .../docs/02-self-hosting/02-self-hosting.md | 30 ++----------------- .../docs/02-self-hosting/03-configuration.md | 28 +++++++++++++++++ 2 files changed, 31 insertions(+), 27 deletions(-) create mode 100644 website/docs/02-self-hosting/03-configuration.md diff --git a/website/docs/02-self-hosting/02-self-hosting.md b/website/docs/02-self-hosting/02-self-hosting.md index e082a37..69cae0a 100644 --- a/website/docs/02-self-hosting/02-self-hosting.md +++ b/website/docs/02-self-hosting/02-self-hosting.md @@ -1,30 +1,6 @@ # Self Hosting -## Configuration +Tabby can be deployed on the server side using Docker or as client-side software, harnessing the computing power of Mac M1/M2. Please refer to each individual page for more information. -:::tip -The configuration file is not mandatory; Tabby can be run with just a single line of command. -::: - -Server config can be found at `~/.tabby/config.toml` - -it looks something like this - -```toml -[[repositories]] -git_url = "https://github.com/TabbyML/tabby.git" -``` - -| Parameter | Description | -| ------------------------- | ----------------------------------------------------------------------------------- | -| `repository` | List of source code repository to integrate with the instance. | -| `repository.git_url` | URL to git repository, where tabby extract snippets for prompting and fine tuning. | - -## Usage Collection -Tabby collects usage stats by default. This data will only be used by the Tabby team to improve its services. - -### What data is collected? -We collect non-sensitive data that helps us understand how Tabby is used. For now we collects `serve` command you used to start the server. - -### How to disable it -To disable usage collection, set the `TABBY_DISABLE_USAGE_COLLECTION` environment variable by `export TABBY_DISABLE_USAGE_COLLECTION=1`. +* [Docker](./docker) +* [Mac M1/M2 (Preview)](./apple) diff --git a/website/docs/02-self-hosting/03-configuration.md b/website/docs/02-self-hosting/03-configuration.md new file mode 100644 index 0000000..ff57294 --- /dev/null +++ b/website/docs/02-self-hosting/03-configuration.md @@ -0,0 +1,28 @@ +# Configuration + +:::tip +The configuration file is not mandatory; Tabby can be run with just a single line of command. +::: + +Server config can be found at `~/.tabby/config.toml` + +it looks something like this + +```toml +[[repositories]] +git_url = "https://github.com/TabbyML/tabby.git" +``` + +| Parameter | Description | +| ------------------------- | ----------------------------------------------------------------------------------- | +| `repository` | List of source code repository to integrate with the instance. | +| `repository.git_url` | URL to git repository, where tabby extract snippets for prompting and fine tuning. | + +## Usage Collection +Tabby collects usage stats by default. This data will only be used by the Tabby team to improve its services. + +### What data is collected? +We collect non-sensitive data that helps us understand how Tabby is used. For now we collects `serve` command you used to start the server. + +### How to disable it +To disable usage collection, set the `TABBY_DISABLE_USAGE_COLLECTION` environment variable by `export TABBY_DISABLE_USAGE_COLLECTION=1`.